GNU bug report logs - #43307
28.0.50; `diff-no-select': no documentation for BUF argument

Previous Next

Full log

Message #15 received at 43307 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: p.stephani2 <at> gmail.com, 43307 <at> debbugs.gnu.org
Subject: Re: bug#43307: 28.0.50;
 `diff-no-select': no documentation for BUF argument
Date: Fri, 11 Sep 2020 09:07:54 +0300

> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Date: Thu, 10 Sep 2020 23:04:14 +0200
> Cc: 43307 <at> debbugs.gnu.org
> 
> Philipp Stephani <p.stephani2 <at> gmail.com> writes:
> 
> > The signature for `diff-no-select' is:
> >
> > (diff-no-select OLD NEW &optional SWITCHES NO-ASYNC BUF)
> >
> > Its docstring refers to `diff' for the meaning of the arguments, but
> > `diff' doesn't take an argument, so BUF is undocumented.
> >
> > Probably `diff-no-select' should also document that the return value is
> > BUF if BUF is non-nil.
> 
> I've now amended the doc string of the function on Emacs 28.

Thanks, but please backport this to the release branch, as doc changes
should be installed there.

Also, the new doc string of diff-no-select uses too much of passive
tense; can we improve that?

And finally, the SWITCHES argument is left semi-documented, since the
doc string of 'diff' doesn't tell what happens in non-interactive
calls if SWITCHES is specified, and doesn't say what should be its
form in that case.

Previous Next

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