diff options
author | Eli Zaretskii <eliz@gnu.org> | 2022-12-16 17:32:05 +0200 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2022-12-16 17:32:05 +0200 |
commit | c26ab22cf4e8655255d09f929c0d842ba162da22 (patch) | |
tree | 0979247c07a17e7267bf7a59e360ff38f7b8b5e0 /lisp/simple.el | |
parent | 80f410d281c6892c6aab4ce9b0a5bf052c7d88da (diff) | |
download | emacs-c26ab22cf4e8655255d09f929c0d842ba162da22.tar.gz |
; Improve doc strings of minibuffer-history commands
* lisp/simple.el (goto-history-element, next-history-element)
(previous-history-element): Doc fixes. (Bug#60103)
Diffstat (limited to 'lisp/simple.el')
-rw-r--r-- | lisp/simple.el | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/lisp/simple.el b/lisp/simple.el index 654b56a0886..f85428ca740 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -2929,11 +2929,12 @@ that was current when the minibuffer was activated." (window-buffer (minibuffer-selected-window)))) (defun goto-history-element (nabs) - "Puts element of the minibuffer history in the minibuffer. -The argument NABS specifies the absolute history position in -descending order, where 0 means the current element and a -positive number N means the Nth previous element. NABS being a -negative number -N means the Nth entry of \"future history.\"" + "Insert into the minibuffer the element of minibuffer history specified by NABS. +Interactively, NABS is the prefix numeric argument, and defaults to 1. +It specifies the absolute history position in descending order, +where 0 means the current element and a positive number N means +the Nth previous element. NABS that is a negative number -N means +the Nth entry of \"future history.\"" (interactive "p") (when (and (not minibuffer-default-add-done) (functionp minibuffer-default-add-function) @@ -2989,17 +2990,17 @@ negative number -N means the Nth entry of \"future history.\"" (goto-char (or minibuffer-temporary-goal-position (point-max))))) (defun next-history-element (n) - "Puts next element of the minibuffer history in the minibuffer. -With argument N, it uses the Nth following element. The position -in the history can go beyond the current position and invoke \"future -history.\"" + "Insert into the minibuffer the Nth next element of minibuffer history. +Interactively, N is the prefix numeric argument and defaults to 1. +The value N can go beyond the current position in the minibuffer +history, and invoke \"future history.\"" (interactive "p") (or (zerop n) (goto-history-element (- minibuffer-history-position n)))) (defun previous-history-element (n) - "Puts previous element of the minibuffer history in the minibuffer. -With argument N, it uses the Nth previous element." + "Insert into the minibuffer the Nth previous element of minibuffer history. +Interactively, N is the prefix numeric argument and defaults to 1." (interactive "p") (or (zerop n) (goto-history-element (+ minibuffer-history-position n)))) |