From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 21 Oct 2017 08:36:37 +0000 (+0300)
Subject: Fix doc strings in simple.el
X-Git-Tag: emacs-26.0.91~502
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c9d71b31bf1144c3f11a82612f07a7bd649c25d4;p=emacs.git

Fix doc strings in simple.el

* lisp/simple.el (shell-command-saved-pos)
(region-extract-function, region-bounds): Doc fixes.  (Bug#28609)
---

diff --git a/lisp/simple.el b/lisp/simple.el
index 5ef511ce0a0..12d65e50c34 100644
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -53,9 +53,10 @@ restores the buffer position before the command."
   :version "26.1")
 
 (defvar shell-command-saved-pos nil
-  "Position of point in the output buffer after command completes.
-It is a cons cell of the form (BUFFER . POS), where BUFFER is the output
-buffer, and POS is the point position in BUFFER once the command finishes.
+  "Record of point positions in output buffers after command completion.
+The value is an alist whose elements are of the form (BUFFER . POS),
+where BUFFER is the output buffer, and POS is the point position
+in BUFFER once the command finishes.
 This variable is used when `shell-command-dont-erase-buffer' is non-nil.")
 
 (defcustom idle-update-delay 0.5
@@ -1003,7 +1004,7 @@ Called with one argument METHOD.
 If METHOD is `delete-only', then delete the region; the return value
 is undefined.  If METHOD is nil, then return the content as a string.
 If METHOD is `bounds', then return the boundaries of the region
-as a cons cell of the form (START . END).
+as a list of cons cells of the form (START . END).
 If METHOD is anything else, delete the region and return its content
 as a string, after filtering it with `filter-buffer-substring', which
 is called with METHOD as its 3rd argument.")
@@ -5474,7 +5475,7 @@ also checks the value of `use-empty-active-region'."
 
 (defun region-bounds ()
   "Return the boundaries of the region as a pair of positions.
-Value is a cons cell of the form (START . END)."
+Value is a list of cons cells of the form (START . END)."
   (funcall region-extract-function 'bounds))
 
 (defun region-noncontiguous-p ()