[Emacs-diffs] /srv/bzr/emacs/emacs-23 r100269: Doc fixes for comint functions (Bug#7499).

[Chong Yidong]

------------------------------------------------------------
revno: 100269
committer: Chong Yidong <address@hidden>
branch nick: emacs-23
timestamp: Sat 2010-12-04 19:55:00 -0500
message:
  Doc fixes for comint functions (Bug#7499).
  
  * lisp/comint.el (comint-dynamic-list-input-ring)
  (comint-dynamic-complete-filename)
  (comint-replace-by-expanded-filename)
  (comint-dynamic-simple-complete)
  (comint-dynamic-list-filename-completions)
  (comint-dynamic-list-completions): Doc fix (Bug#7499).
modified:
  lisp/ChangeLog
  lisp/comint.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2010-12-05 00:43:18 +0000
+++ b/lisp/ChangeLog    2010-12-05 00:55:00 +0000
@@ -1,5 +1,12 @@
 2010-12-05  Chong Yidong  <address@hidden>
 
+       * comint.el (comint-dynamic-list-input-ring)
+       (comint-dynamic-complete-filename)
+       (comint-replace-by-expanded-filename)
+       (comint-dynamic-simple-complete)
+       (comint-dynamic-list-filename-completions)
+       (comint-dynamic-list-completions): Doc fix (Bug#7499).
+
        * subr.el (posn-x-y, posn-object-x-y, posn-object-width-height):
        Doc fix (Bug#7471).
 

=== modified file 'lisp/comint.el'
--- a/lisp/comint.el    2010-11-18 03:44:35 +0000
+++ b/lisp/comint.el    2010-12-05 00:55:00 +0000
@@ -1000,7 +1000,7 @@
     (choose-completion-string completion buffer)))
 
 (defun comint-dynamic-list-input-ring ()
-  "List in help buffer the buffer's input history."
+  "Display a list of recent inputs entered into the current buffer."
   (interactive)
   (if (or (not (ring-p comint-input-ring))
          (ring-empty-p comint-input-ring))
@@ -2996,7 +2996,7 @@
 This function is similar to `comint-replace-by-expanded-filename', except that
 it won't change parts of the filename already entered in the buffer; it just
 adds completion characters to the end of the filename.  A completions listing
-may be shown in a help buffer if completion is ambiguous.
+may be shown in a separate buffer if completion is ambiguous.
 
 Completion is dependent on the value of `comint-completion-addsuffix',
 `comint-completion-recexact' and `comint-completion-fignore', and the timing of
@@ -3083,11 +3083,11 @@
 
 (defun comint-replace-by-expanded-filename ()
   "Dynamically expand and complete the filename at point.
-Replace the filename with an expanded, canonicalized and completed replacement.
-\"Expanded\" means environment variables (e.g., $HOME) and `~'s are replaced
-with the corresponding directories.  \"Canonicalized\" means `..'  and `.' are
-removed, and the filename is made absolute instead of relative.  For expansion
-see `expand-file-name' and `substitute-in-file-name'.  For completion see
+Replace the filename with an expanded, canonicalized and
+completed replacement, i.e. substituting environment
+variables (e.g. $HOME), `~'s, `..', and `.', and making the
+filename absolute.  For expansion see `expand-file-name' and
+`substitute-in-file-name'.  For completion see
 `comint-dynamic-complete-filename'."
   (interactive)
   (let ((filename (comint-match-partial-filename)))
@@ -3098,15 +3098,16 @@
 
 (defun comint-dynamic-simple-complete (stub candidates)
   "Dynamically complete STUB from CANDIDATES list.
-This function inserts completion characters at point by completing STUB from
-the strings in CANDIDATES.  A completions listing may be shown in a help buffer
-if completion is ambiguous.
+This function inserts completion characters at point by
+completing STUB from the strings in CANDIDATES.  If completion is
+ambiguous, possibly show a completions listing in a separate
+buffer.
 
-Returns nil if no completion was inserted.
-Returns `sole' if completed with the only completion match.
-Returns `shortest' if completed with the shortest of the completion matches.
-Returns `partial' if completed as far as possible with the completion matches.
-Returns `listed' if a completion listing was shown.
+Return nil if no completion was inserted.
+Return `sole' if completed with the only completion match.
+Return `shortest' if completed with the shortest match.
+Return `partial' if completed as far as possible.
+Return `listed' if a completion listing was shown.
 
 See also `comint-dynamic-complete-filename'."
   (let* ((completion-ignore-case (memq system-type '(ms-dos windows-nt 
cygwin)))
@@ -3154,7 +3155,7 @@
 
 
 (defun comint-dynamic-list-filename-completions ()
-  "List in help buffer possible completions of the filename at point."
+  "Display a list of possible completions for the filename at point."
   (interactive)
   (let* ((completion-ignore-case read-file-name-completion-ignore-case)
         ;; If we bind this, it breaks remote directory tracking in rlogin.el.
@@ -3183,9 +3184,9 @@
 (defvar comint-dynamic-list-completions-config nil)
 
 (defun comint-dynamic-list-completions (completions &optional common-substring)
-  "List in help buffer sorted COMPLETIONS.
+  "Display a list of sorted COMPLETIONS.
 The meaning of COMMON-SUBSTRING is the same as in `display-completion-list'.
-Typing SPC flushes the help buffer."
+Typing SPC flushes the completions buffer."
   (let ((window (get-buffer-window "*Completions*" 0)))
     (setq completions (sort completions 'string-lessp))
     (if (and (eq last-command this-command)