GNU bug report logs - #5325
23.1.91; doc string of dired-insert-set-properties

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 5325 in the body.
You can then email your comments to 5325 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: <emacs-pretest-bug <at> gnu.org>
Subject: 23.1.91; doc string of dired-insert-set-properties
Date: Tue, 5 Jan 2010 15:02:53 -0800

emacs -Q
 
The doc string is:
"Make the file names highlight when the mouse is on them."
 
The function name does not at all reflect what the function does, for
one thing.  This makes it all the more important that the doc string
does reflect what the function does.
 
Prior to Emacs 23, the doc string was complete and accurate. Starting
with Emacs 23, this function does something additional, which is quite
important: it puts the `dired-filename' text property on the file name.
This is at least as important as the fact that the function adds the
`mouse-face' property to highlight the file name.
 
Especially since property `dired-filename' is set here for use
elsewhere.  The connection between `dired-insert-set-properties' and
`dired-move-to(-end-of)-filename' is not obvious.  If there were more
occurrences of `dired-filename' in the file it would be even harder to
see this connection.
 
A sentence such as this should be added to the doc string:
"Add text property `dired-filename' to the file name."
 
In GNU Emacs 23.1.91.1 (i386-mingw-nt5.1.2600)
 of 2010-01-02 on PRETEST
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4)'
 

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 5325 <at> debbugs.gnu.org
Subject: Re: 23.1.91; doc string of dired-insert-set-properties
Date: Wed, 13 Jul 2011 17:15:57 +0200

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

> Prior to Emacs 23, the doc string was complete and accurate. Starting
> with Emacs 23, this function does something additional, which is quite
> important: it puts the `dired-filename' text property on the file name.
> This is at least as important as the fact that the function adds the
> `mouse-face' property to highlight the file name.

I've now updated the doc string.

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