From: "Daniel Shahaf" <danielsh@apache.org>
To: zsh-workers@zsh.org
Subject: Re: [PATCH] internal: Add symbolic names to possible values of zexit()'s "from_where" parameter. No functional change.
Date: Tue, 17 Dec 2019 10:02:50 +0000 [thread overview]
Message-ID: <0ecc07ce-4a29-4057-9c50-eb7151648b4a@www.fastmail.com> (raw)
In-Reply-To: <CAHYJk3S9NAzt8tQVVO-q_J+a8nOpNtKNQ1BO6XQP3os24_RkvA@mail.gmail.com>
Mikael Magnusson wrote on Tue, 17 Dec 2019 09:46 +00:00:
> On 12/17/19, dana <dana@dana.is> wrote:
> > On 17 Dec 2019, at 01:51, Daniel Shahaf <danielsh@apache.org> 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.
prev parent reply other threads:[~2019-12-17 10:04 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-12-17 4:46 Daniel Shahaf
2019-12-17 7:21 ` dana
2019-12-17 7:32 ` Daniel Shahaf
2019-12-17 7:41 ` dana
2019-12-17 7:51 ` Daniel Shahaf
2019-12-17 7:57 ` dana
2019-12-17 9:46 ` Mikael Magnusson
2019-12-17 10:02 ` Daniel Shahaf [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=0ecc07ce-4a29-4057-9c50-eb7151648b4a@www.fastmail.com \
--to=danielsh@apache.org \
--cc=zsh-workers@zsh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.vuxu.org/mirror/zsh/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).