diff options
author | Eli Zaretskii <eliz@gnu.org> | 2017-10-21 11:36:37 +0300 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2017-10-21 11:36:37 +0300 |
commit | c9d71b31bf1144c3f11a82612f07a7bd649c25d4 (patch) | |
tree | 09022a886a8a826f31552323072f2e9468568f3b | |
parent | 0d8e4f45d612ecd77f4997fae30e4d1591f9b8a6 (diff) | |
download | emacs-c9d71b31bf1144c3f11a82612f07a7bd649c25d4.tar.gz emacs-c9d71b31bf1144c3f11a82612f07a7bd649c25d4.tar.bz2 emacs-c9d71b31bf1144c3f11a82612f07a7bd649c25d4.zip |
Fix doc strings in simple.el
* lisp/simple.el (shell-command-saved-pos)
(region-extract-function, region-bounds): Doc fixes. (Bug#28609)
-rw-r--r-- | lisp/simple.el | 11 |
1 files changed, 6 insertions, 5 deletions
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 () |