Zsh Mailing List Archive
Messages sorted by: Reverse Date, Date, Thread, Author

Re: [PATCH] internal: Add symbolic names to possible values of zexit()'s "from_where" parameter. No functional change.

Mikael Magnusson wrote on Tue, 17 Dec 2019 09:46 +00:00:
> On 12/17/19, dana <dana@xxxxxxx> wrote:
> > On 17 Dec 2019, at 01:51, Daniel Shahaf <danielsh@xxxxxxxxxx> wrote:
> >> It's not a mistake.  "which" refers to "zexit()'s second parameter", and
> >> is the direct object of the verb "see".  It's a set phrase — probably
> >> began as a translation of <https://en.wiktionary.org/wiki/q.v.#Adverb>.
> >
> > Oh, somehow i had never seen it written like that. Just my ignorance then,
> > sorry for the noise
> I also have never seen it, and it seems to add no information to the
> sentence either (I already know that following references is an
> option). Remove to reduce confusion for readers?

I wrote it deliberately, since I felt that documenting an enum type as
"This is the type of the 2nd parameter to some_func()" wouldn't be best
practice either.  The "which see" addendum was intended to convey: "Yes,
this docstring doesn't tell you all of the information a docstring
is expected to convey; instead, that information is behind the
given pointer".

However, I don't feel strongly about it.  Whatever people prefer works for me.

Messages sorted by: Reverse Date, Date, Thread, Author