unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#7758: 24.0.50; doc string and args of `dired-revert'
@ 2010-12-29 19:10 Drew Adams
  2011-01-23 20:06 ` Chong Yidong
  0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2010-12-29 19:10 UTC (permalink / raw)
  To: 7758

(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'






^ permalink raw reply	[flat|nested] 2+ messages in thread

* bug#7758: 24.0.50; doc string and args of `dired-revert'
  2010-12-29 19:10 bug#7758: 24.0.50; doc string and args of `dired-revert' Drew Adams
@ 2011-01-23 20:06 ` Chong Yidong
  0 siblings, 0 replies; 2+ messages in thread
From: Chong Yidong @ 2011-01-23 20:06 UTC (permalink / raw)
  To: Drew Adams; +Cc: 7758

"Drew Adams" <drew.adams@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.





^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2011-01-23 20:06 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-12-29 19:10 bug#7758: 24.0.50; doc string and args of `dired-revert' Drew Adams
2011-01-23 20:06 ` Chong Yidong

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).