[Emacs-diffs] /srv/bzr/emacs/trunk r109436: * wdired.el (wdired-mode, wdired-change-to-wdired-mode): Doc fixes.

[Chong Yidong]

------------------------------------------------------------
revno: 109436
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Sun 2012-08-05 12:19:21 +0800
message:
  * wdired.el (wdired-mode, wdired-change-to-wdired-mode): Doc fixes.
modified:
  lisp/ChangeLog
  lisp/wdired.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-08-05 03:52:02 +0000
+++ b/lisp/ChangeLog    2012-08-05 04:19:21 +0000
@@ -1,5 +1,8 @@
 2012-08-05  Chong Yidong  <address@hidden>
 
+       * wdired.el (wdired-mode, wdired-change-to-wdired-mode): Doc
+       fixes.
+
        * fringe.el (fringe-styles): Add docstring.
        (fringe--check-mode): New function.
        (set-fringe-mode, set-fringe-style): Use it.

=== modified file 'lisp/wdired.el'
--- a/lisp/wdired.el    2012-07-11 23:13:41 +0000
+++ b/lisp/wdired.el    2012-08-05 04:19:21 +0000
@@ -183,14 +183,21 @@
 
 
 (defun wdired-mode ()
-  "Writable Dired mode.
+  "Writable Dired (WDired) mode.
 \\<wdired-mode-map>
-Press \\[wdired-finish-edit] to make the changes to take effect
-and exit.  To abort the edit, use \\[wdired-abort-changes].
-
-In this mode you can edit the names of the files, the target of
-the links and the permission bits of the files.  You can use
-\\[customize-group] RET wdired to customize WDired behavior.
+In WDired mode, you can edit the names of the files in the
+buffer, the target of the links, and the permission bits of the
+files.
+
+Type \\[wdired-finish-edit] to exit WDired mode, returning to
+Dired mode, and make your edits \"take effect\" by modifying the
+file and directory names, link targets, and/or file permissions
+on disk.  If you delete the filename of a file, it is flagged for
+deletion in the Dired buffer.
+
+Type \\[wdired-abort-changes] to abort your edits and exit WDired mode.
+
+Type \\[customize-group] RET wdired to customize WDired behavior.
 
 The only editable texts in a WDired buffer are filenames,
 symbolic link targets, and filenames permission."
@@ -201,16 +208,17 @@
 
 ;;;###autoload
 (defun wdired-change-to-wdired-mode ()
-  "Put a dired buffer in a mode in which filenames are editable.
+  "Put a Dired buffer in Writable Dired (WDired) mode.
 \\<wdired-mode-map>
-This mode allows the user to change the names of the files, and after
-typing \\[wdired-finish-edit] Emacs renames the files and directories
-in disk.
+In WDired mode, you can edit the names of the files in the
+buffer, the target of the links, and the permission bits of the
+files.  After typing \\[wdired-finish-edit], Emacs modifies the files and
+directories to reflect your edits.
 
 See `wdired-mode'."
   (interactive)
-  (or (eq major-mode 'dired-mode)
-      (error "Not a Dired buffer"))
+  (unless (eq major-mode 'dired-mode)
+    (error "Not a Dired buffer"))
   (set (make-local-variable 'wdired-old-content)
        (buffer-substring (point-min) (point-max)))
   (set (make-local-variable 'wdired-old-point) (point))