* bug#17566: 24.4.50; describe parameters in doc string: `dired-move-to-filename' etc.
@ 2014-05-23 18:39 Drew Adams
2019-10-07 17:44 ` Lars Ingebrigtsen
0 siblings, 1 reply; 2+ messages in thread
From: Drew Adams @ 2014-05-23 18:39 UTC (permalink / raw)
To: 17566
Subject line says it all. Parameters should be described in doc
strings! In the case of `dired-move-to-filename' it is not at all
obvious what parameter RAISE-ERROR means, for example. Even the code
comments seem to have trouble describing what RAISE-ERROR is for.
In GNU Emacs 24.4.50.1 (i686-pc-mingw32)
of 2014-05-17 on ODIEONE
Bzr revision: 117119 eggert@cs.ucla.edu-20140517081131-ugu7ociaoec2xk7y
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
`configure --prefix=/c/Devel/emacs/snapshot/trunk
--enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
-Ic:/Devel/emacs/include''
^ permalink raw reply [flat|nested] 2+ messages in thread
* bug#17566: 24.4.50; describe parameters in doc string: `dired-move-to-filename' etc.
2014-05-23 18:39 bug#17566: 24.4.50; describe parameters in doc string: `dired-move-to-filename' etc Drew Adams
@ 2019-10-07 17:44 ` Lars Ingebrigtsen
0 siblings, 0 replies; 2+ messages in thread
From: Lars Ingebrigtsen @ 2019-10-07 17:44 UTC (permalink / raw)
To: Drew Adams; +Cc: 17566
Drew Adams <drew.adams@oracle.com> writes:
> Subject line says it all. Parameters should be described in doc
> strings! In the case of `dired-move-to-filename' it is not at all
> obvious what parameter RAISE-ERROR means, for example. Even the code
> comments seem to have trouble describing what RAISE-ERROR is for.
I've now documented the parameters to that function in Emacs 27.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-10-07 17:44 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-05-23 18:39 bug#17566: 24.4.50; describe parameters in doc string: `dired-move-to-filename' etc Drew Adams
2019-10-07 17:44 ` Lars Ingebrigtsen
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).