procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix doc strings in simple.el

Browse source 
* lisp/simple.el (shell-command-saved-pos)
(region-extract-function, region-bounds): Doc fixes.  (Bug#28609)
This commit is contained in:
Eli Zaretskii 2017-10-21 11:36:37 +03:00
parent 0d8e4f45d6
commit c9d71b31bf
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
lisp/simple.el
View file

@ -53,9 +53,10 @@ restores the buffer position before the command."
:version "26.1") :version "26.1")
(defvar shell-command-saved-pos nil (defvar shell-command-saved-pos nil
"Position of point in the output buffer after command completes. "Record of point positions in output buffers after command completion.
It is a cons cell of the form (BUFFER . POS), where BUFFER is the output The value is an alist whose elements are of the form (BUFFER . POS),
buffer, and POS is the point position in BUFFER once the command finishes. 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.") This variable is used when `shell-command-dont-erase-buffer' is non-nil.")
(defcustom idle-update-delay 0.5 (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 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. is undefined. If METHOD is nil, then return the content as a string.
If METHOD is `bounds', then return the boundaries of the region 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 If METHOD is anything else, delete the region and return its content
as a string, after filtering it with `filter-buffer-substring', which as a string, after filtering it with `filter-buffer-substring', which
is called with METHOD as its 3rd argument.") is called with METHOD as its 3rd argument.")
@ -5474,7 +5475,7 @@ also checks the value of `use-empty-active-region'."
(defun region-bounds () (defun region-bounds ()
"Return the boundaries of the region as a pair of positions. "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)) (funcall region-extract-function 'bounds))
(defun region-noncontiguous-p () (defun region-noncontiguous-p ()