GNU bug report logs - #17566
24.4.50; describe parameters in doc string: `dired-move-to-filename' etc.

Previous Next

Package: emacs;

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

Date: Fri, 23 May 2014 18:40:01 UTC

Severity: minor

Tags: fixed

Found in version 24.4.50

Fixed in version 27.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

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 17566 in the body.
You can then email your comments to 17566 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 bug-gnu-emacs <at> gnu.org:
bug#17566; Package emacs. (Fri, 23 May 2014 18:40:02 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. (Fri, 23 May 2014 18:40:03 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.4.50; describe parameters in doc string: `dired-move-to-filename'
 etc.
Date: Fri, 23 May 2014 11:39:01 -0700 (PDT)

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 <at> 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''
Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#17566; Package emacs. (Mon, 07 Oct 2019 17:45:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 17566 <at> debbugs.gnu.org
Subject: Re: bug#17566: 24.4.50; describe parameters in doc string:
 `dired-move-to-filename' etc.
Date: Mon, 07 Oct 2019 19:44:44 +0200

Drew Adams <drew.adams <at> 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
Added tag(s) fixed. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Mon, 07 Oct 2019 17:45:02 GMT) Full text and rfc822 format available.
bug marked as fixed in version 27.1, send any further explanations to 17566 <at> debbugs.gnu.org and Drew Adams <drew.adams <at> oracle.com> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Mon, 07 Oct 2019 17:45: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. (Tue, 05 Nov 2019 12:24:06 GMT) Full text and rfc822 format available.
This bug report was last modified 4 years and 166 days ago.

Previous Next

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