GNU bug report logs - #67217
[PATCH] Improve docstring argument conventions

Previous Next

Full log

Message #16 received at 67217-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Jeremy Bryant <jb <at> jeremybryant.net>
Cc: 67217-done <at> debbugs.gnu.org
Subject: Re: bug#67217: [PATCH] Improve docstring argument conventions
Date: Fri, 17 Nov 2023 09:06:16 +0200

> From: Jeremy Bryant <jb <at> jeremybryant.net>
> Cc: 67217 <at> debbugs.gnu.org
> Date: Thu, 16 Nov 2023 23:55:29 +0000
> 
> 
> Eli Zaretskii <eliz <at> 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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.