From: Eli Zaretskii <eliz@gnu.org>
To: Jeremy Bryant <jb@jeremybryant.net>
Cc: 67217-done@debbugs.gnu.org
Subject: bug#67217: [PATCH] Improve docstring argument conventions
Date: Fri, 17 Nov 2023 09:06:16 +0200 [thread overview]
Message-ID: <83a5rcq2on.fsf@gnu.org> (raw)
In-Reply-To: <87v8a1tfoo.fsf@jeremybryant.net> (message from Jeremy Bryant on Thu, 16 Nov 2023 23:55:29 +0000)
> From: Jeremy Bryant <jb@jeremybryant.net>
> Cc: 67217@debbugs.gnu.org
> Date: Thu, 16 Nov 2023 23:55:29 +0000
>
>
> Eli Zaretskii <eliz@gnu.org> writes:
>
> > So let me turn the table and ask you: why did you think the existing
> > text is insufficient in this aspect?
>
> I thought your wording was clearer than the manual and proposed adapting
> the manual to your wording and to be more explicit about mandatory and optional.
>
> I accept that it is comparable.
"Mandatory" is just my personal rule of thumb, which is just easy to
explain. But maybe you are right, and it helps explain this tip,
thanks for pointing that out. So I've now added a note about
mandatory arguments there, in the hope that it helps.
And with that, I'm closing the bug.
prev parent reply other threads:[~2023-11-17 7:06 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-15 23:47 bug#67217: [PATCH] Improve docstring argument conventions Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-16 6:15 ` Eli Zaretskii
2023-11-16 23:55 ` Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-11-17 7:06 ` Eli Zaretskii [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=83a5rcq2on.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=67217-done@debbugs.gnu.org \
--cc=jb@jeremybryant.net \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.