GNU bug report logs - #12674
24.2.50; doc of `locate-file'

Previous Next

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

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

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.2.50; doc of `locate-file'
Date: Thu, 18 Oct 2012 09:28:15 -0700

The description in the Elisp manual is fine.  The doc string is
generally OK, except for its second sentence.  This part of the second
sentence is not clear (meaningless, misleading): ", with its suffixes".
 
It's unclear what that might mean (return the absolute file name, plus a
list of its suffixes?).  But it certainly cannot mean what really
happens: the absolute file name is returned, including ONE of the
suffixes if appropriate.
 
Just say what the manual says: the absolute file name is returned:
 
 If it finds such a file, it returns the file's absolute file name;
 otherwise it returns `nil'.

In GNU Emacs 24.2.50.1 (i386-mingw-nt5.1.2600)
 of 2012-10-15 on DANI-PC
Bzr revision: 110553 monnier <at> iro.umontreal.ca-20121015164957-6zms5w2js1xkldtg
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.7) --no-opt --enable-checking --cflags
 -I../../libs/libxpm-3.5.8/include -I../../libs/libxpm-3.5.8/src
 -I../../libs/libpng-1.4.10 -I../../libs/zlib-1.2.6
 -I../../libs/giflib-4.1.4-1/include -I../../libs/jpeg-6b-4/include
 -I../../libs/tiff-3.8.2-1/include
 -I../../libs/libxml2-2.7.8-w32-bin/include/libxml2
 -I../../libs/gnutls-3.0.16/include
 -I../../libs/libiconv-1.14-2-mingw32-dev/include'
 

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 12674 <at> debbugs.gnu.org
Subject: Re: bug#12674: 24.2.50; doc of `locate-file'
Date: Sat, 08 Feb 2014 18:58:42 -0800

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

> The description in the Elisp manual is fine.  The doc string is
> generally OK, except for its second sentence.  This part of the second
> sentence is not clear (meaningless, misleading): ", with its suffixes".
>
> It's unclear what that might mean (return the absolute file name, plus a
> list of its suffixes?).  But it certainly cannot mean what really
> happens: the absolute file name is returned, including ONE of the
> suffixes if appropriate.
>
> Just say what the manual says: the absolute file name is returned:
>
>  If it finds such a file, it returns the file's absolute file name;
>  otherwise it returns `nil'.

Fixed on trunk.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Previous Next

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