From: Eli Zaretskii Date: Fri, 16 Dec 2022 15:32:05 +0000 (+0200) Subject: ; Improve doc strings of minibuffer-history commands X-Git-Tag: emacs-29.0.90~1128 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c26ab22cf4e;p=emacs.git ; Improve doc strings of minibuffer-history commands * lisp/simple.el (goto-history-element, next-history-element) (previous-history-element): Doc fixes. (Bug#60103) --- 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))))