bug#916: 23.0.60; doc string of dired-get-marked-files

bug#916: 23.0.60; doc string of dired-get-marked-files

[Drew Adams]

The doc string says this about optional arg ARG:
 
Optional second argument arg specifies files near point
 instead of marked files.  If arg is an integer, use the next arg files.
  If arg is otherwise non-nil, use file.  Usually arg comes from
  the command's prefix arg.
 
This is not correct, or at least it is incomplete. It says that the
current file is used if ARG is non-nil but not an integer, which is
true, but it suggests that no file is used if ARG is nil. That is, the
entire ARG description suggests that a singleton list of the current
file is returned only when ARG is non-nil. It suggests that if ARG is
nil then the empty list is returnedl.
 
In fact, if ARG is nil, the current file is used. That is,
(dired-get-marked-files) in Dired returns the singleton list of the
file where the cursor is. This behavior is not a bug; it is the doc
string that is incomplete by not covering this case.
 
The doc string should say something like this regarding ARG:
 
Optional second argument arg specifies files near point instead of
 marked files.  If arg is an integer, use the next arg files.
 Otherwise, use the file on the current line.  Usually arg comes from
 the command's prefix arg.
 
`dired-get-marked-files' uses `dired-map-over-marks', and the doc
string of that function correctly states "If no marked file could be
found, execute body on the current line."
 
 
 
In GNU Emacs 23.0.60.1 (i386-mingw-nt5.1.2600)
 of 2008-08-29 on LENNART-69DE564
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --no-opt --cflags -Ic:/g/include
-fno-crossjumping'
 

bug#916: marked as done (23.0.60; doc string of dired-get-marked-files)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 849 bytes --]


Your message dated Wed, 22 Oct 2008 16:39:40 -0400
with message-id <87tzb4bbzn.fsf@cyd.mit.edu>
and subject line Re: 23.0.60; doc string of dired-get-marked-files
has caused the Emacs bug report #916,
regarding 23.0.60; doc string of dired-get-marked-files
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact don@donarmstrong.com
immediately.)


-- 
916: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=916
Emacs Bug Tracking System
Contact don@donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 4126 bytes --]

From: "Drew Adams" <drew.adams@oracle.com>
To: <emacs-pretest-bug@gnu.org>
Subject: 23.0.60; doc string of dired-get-marked-files
Date: Sun, 7 Sep 2008 10:17:10 -0700
Message-ID: <001d01c9110d$9062a240$0200a8c0@us.oracle.com>

The doc string says this about optional arg ARG:
 
Optional second argument arg specifies files near point
 instead of marked files.  If arg is an integer, use the next arg files.
  If arg is otherwise non-nil, use file.  Usually arg comes from
  the command's prefix arg.
 
This is not correct, or at least it is incomplete. It says that the
current file is used if ARG is non-nil but not an integer, which is
true, but it suggests that no file is used if ARG is nil. That is, the
entire ARG description suggests that a singleton list of the current
file is returned only when ARG is non-nil. It suggests that if ARG is
nil then the empty list is returnedl.
 
In fact, if ARG is nil, the current file is used. That is,
(dired-get-marked-files) in Dired returns the singleton list of the
file where the cursor is. This behavior is not a bug; it is the doc
string that is incomplete by not covering this case.
 
The doc string should say something like this regarding ARG:
 
Optional second argument arg specifies files near point instead of
 marked files.  If arg is an integer, use the next arg files.
 Otherwise, use the file on the current line.  Usually arg comes from
 the command's prefix arg.
 
`dired-get-marked-files' uses `dired-map-over-marks', and the doc
string of that function correctly states "If no marked file could be
found, execute body on the current line."
 
 
 
In GNU Emacs 23.0.60.1 (i386-mingw-nt5.1.2600)
 of 2008-08-29 on LENNART-69DE564
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --no-opt --cflags -Ic:/g/include
-fno-crossjumping'
 




[-- Attachment #3: Type: message/rfc822, Size: 1492 bytes --]

From: Chong Yidong <cyd@stupidchicken.com>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 916-done@emacsbugs.donarmstrong.com
Subject: Re: 23.0.60; doc string of dired-get-marked-files
Date: Wed, 22 Oct 2008 16:39:40 -0400
Message-ID: <87tzb4bbzn.fsf@cyd.mit.edu>

> The doc string says this about optional arg ARG:
> 
> Optional second argument arg specifies files near point
>  instead of marked files.  If arg is an integer, use the next arg files.
>   If arg is otherwise non-nil, use file.  Usually arg comes from
>   the command's prefix arg.
> 
> This is not correct, or at least it is incomplete.

It is correct, because of the word "instead": if ARG is non-nil, it
modifies the behavior of the function.

I fixed the doc string to make this distinction clearer, and to prevent
similar confusion.