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

Previous Next

Full log

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Philipp Stephani <p.stephani2 <at> gmail.com>
Cc: 43307 <at> debbugs.gnu.org
Subject: Re: bug#43307: 28.0.50; `diff-no-select': no documentation for BUF
 argument
Date: Thu, 10 Sep 2020 23:04:14 +0200

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.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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