GNU bug report logs - #4723
23.1; doc strings of `multi-isearch-next(-file)-buffer-from-list'

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 4723 in the body.
You can then email your comments to 4723 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 23.1; doc strings of `multi-isearch-next(-file)-buffer-from-list'
Date: Wed, 14 Oct 2009 13:19:48 -0700

The doc strings of these two functions speak a lot about ChangeLog
buffers. However, there is absolutely nothing in the definitions of
these functions that is particular to ChangeLog buffers.
 
The doc strings should describe these functions (only). Please move
the ChangeLog-relevant info to the appropriate functions that involve
change logs. Presumably, they are consumers of these two functions,
and _for those consumers_, what is said now in these doc strings is
relevant. (It is not relevant to these functions themselves.)
 
Secondly, these two doc strings are currently identical. At least one
of them is therefore not as good as it could be. ;-)
 

In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600)
 of 2009-07-29 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4)'
 

Message #10 received at 4723-done <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Juri Linkov <juri <at> jurta.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 4723-done <at> debbugs.gnu.org
Subject: Re: bug#4723: 23.1; doc strings of `multi-isearch-next(-file)-buffer-from-list'
Date: Thu, 15 Oct 2009 00:52:03 +0300

> The doc strings of these two functions speak a lot about ChangeLog
> buffers. However, there is absolutely nothing in the definitions of
> these functions that is particular to ChangeLog buffers.
>
> The doc strings should describe these functions (only). Please move
> the ChangeLog-relevant info to the appropriate functions that involve
> change logs. Presumably, they are consumers of these two functions,
> and _for those consumers_, what is said now in these doc strings is
> relevant. (It is not relevant to these functions themselves.)
>
> Secondly, these two doc strings are currently identical. At least one
> of them is therefore not as good as it could be. ;-)

Thanks.  This was a copy&paste error.  Fixed.

-- 
Juri Linkov
http://www.jurta.org/emacs/

Previous Next

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