GNU bug report logs - #7758
24.0.50; doc string and args of `dired-revert'

Previous Next

Package: emacs;

Reported by: "Drew Adams" <drew.adams <at> oracle.com>

Date: Wed, 29 Dec 2010 19:06:01 UTC

Severity: normal

Found in version 24.0.50

Done: Chong Yidong <cyd <at> stupidchicken.com>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to owner <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org:
bug#7758; Package emacs. (Wed, 29 Dec 2010 19:06:01 GMT) Full text and rfc822 format available.
Acknowledgement sent to "Drew Adams" <drew.adams <at> oracle.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Wed, 29 Dec 2010 19:06:01 GMT) Full text and rfc822 format available.

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.0.50; doc string and args of `dired-revert'
Date: Wed, 29 Dec 2010 11:10:31 -0800

(defun dired-revert (&optional arg noconfirm)
  "Reread the dired buffer.
Must also be called after `dired-actual-switches' have changed.
Should not fail even on completely garbaged buffers.
Preserves old cursor, marks/flags, hidden-p."
 ...)
 
The doc string should say that there are two optionl arguments and they
are never used.  And it should say explicitly that this is because this
function is used as a value of `revert-buffer-function'.  The last part
is important - users should be able to see the connection easily.
 
And it would be better to name the args for this function IGNORE1 and
IGNORE2 or some such.
 

In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2010-12-20 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.4) --no-opt --cflags
-Ic:/imagesupport/include'
Information forwarded to owner <at> debbugs.gnu.org, bug-gnu-emacs <at> gnu.org:
bug#7758; Package emacs. (Sun, 23 Jan 2011 19:59:01 GMT) Full text and rfc822 format available.

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

From: Chong Yidong <cyd <at> stupidchicken.com>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 7758 <at> debbugs.gnu.org
Subject: Re: bug#7758: 24.0.50; doc string and args of `dired-revert'
Date: Sun, 23 Jan 2011 15:06:47 -0500

"Drew Adams" <drew.adams <at> oracle.com> writes:

> The doc string should say that there are two optionl arguments and they
> are never used.  And it should say explicitly that this is because this
> function is used as a value of `revert-buffer-function'.  The last part
> is important - users should be able to see the connection easily.

Fixed, thanks.
bug closed, send any further explanations to "Drew Adams" <drew.adams <at> oracle.com> Request was from Chong Yidong <cyd <at> stupidchicken.com> to control <at> debbugs.gnu.org. (Sun, 23 Jan 2011 20:00:03 GMT) Full text and rfc822 format available.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Mon, 21 Feb 2011 12:24:04 GMT) Full text and rfc822 format available.
This bug report was last modified 14 years and 174 days ago.

Previous Next

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