GNU bug report logs - #8817
24.0.50; doc string of `dired'

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 8817 in the body.
You can then email your comments to 8817 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.0.50; doc string of `dired'
Date: Tue, 7 Jun 2011 15:27:56 -0700

1. Change "Instead, type d to flag a file for Deletion." to "Type `d' to
flag a file for Deletion."  The "Instead," refers to nothing at all here
- instead of what?
 
2. Change "SPC and DEL can be used" to "Use `SPC' and `DEL'" (active
voice; construction parallel to the other statements.)
 
3. Change "a single or the marked files" to "a single file or the marked
files", or better yet to "the file at point or the marked files".
 
4. Put all keys in single quotes for clarity: change "g" to "`g'" etc.
 
5. Change "Letters no longer insert themselvs" to "The buffer is
read-only".  (It's not just letters, but other chars also - no char
inserts itself.  And there is no "no longer" here - it's not about time
at all.)
 
6. There is no need to say "You can move using the usual cursor motion
commands."  Remove this.
 
7. Change "or all files of a subdirectory" to "or all files of an
inserted subdirectory".
 
8. Change "to flag a file for Deletion" to "to flag a file `D' for
deletion", to be clearer.  (Yes, flagging implies `D', but it helps to
reinforce the meaning.)
 
9. Change "and unflag" to "and unflag for deletion", to be clearer.
 
10. Change "to execute the deletions requested" to "to delete (eXecute)
the files flagged `D'".
 
 
 
In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-06-06 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'
 

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

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8817-close <at> debbugs.gnu.org
Subject: Re: bug#8817: 24.0.50; doc string of `dired'
Date: Fri, 01 Jul 2011 13:58:21 +0200

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

> 1. Change "Instead, type d to flag a file for Deletion." to "Type `d' to
> flag a file for Deletion."  The "Instead," refers to nothing at all here
> - instead of what?

I've applied all your suggested doc changes to Emacs 24.

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