summaryrefslogtreecommitdiff
path: root/src/minibuf.c
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2025-01-11 12:40:59 +0200
committerEli Zaretskii <eliz@gnu.org>2025-01-11 12:40:59 +0200
commitee61b9a050b4fbc9940d11bc95437e5113865c8b (patch)
tree4dc23b71c670bb4262a27edd59c9a7631749a993 /src/minibuf.c
parentce43d13593a44ba36ba6702cf276fef8711ab738 (diff)
downloademacs-ee61b9a050b4fbc9940d11bc95437e5113865c8b.tar.gz
emacs-ee61b9a050b4fbc9940d11bc95437e5113865c8b.tar.bz2
emacs-ee61b9a050b4fbc9940d11bc95437e5113865c8b.zip
; Fix documentation of completion commands
* src/minibuf.c (Fcompleting_read): Move part of doc string of 'read-from-minibuffer' to doc string of this function. Suggested by Eshel Yaron <me@eshelyaron.com>.
Diffstat (limited to 'src/minibuf.c')
-rw-r--r--src/minibuf.c10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/minibuf.c b/src/minibuf.c
index e0d060a0480..bf9fad48d88 100644
--- a/src/minibuf.c
+++ b/src/minibuf.c
@@ -1293,11 +1293,6 @@ barf_if_interaction_inhibited (void)
DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
Sread_from_minibuffer, 1, 7, 0,
doc: /* Read a string from the minibuffer, prompting with string PROMPT.
-While in the minibuffer, you can use \\<minibuffer-local-completion-map>\\[minibuffer-complete] and \\[minibuffer-complete-word] to complete your input.
-You can also use \\<minibuffer-local-map>\\[minibuffer-complete-history] to complete using history items in the
-input history HIST, and you can use \\[minibuffer-complete-defaults] to complete using
-the default items in DEFAULT-VALUE.
-
The optional second arg INITIAL-CONTENTS is an obsolete alternative to
DEFAULT-VALUE. It normally should be nil in new code, except when
HIST is a cons. It is discussed in more detail below.
@@ -1983,6 +1978,11 @@ with a space are ignored unless STRING itself starts with a space. */)
DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0,
doc: /* Read a string in the minibuffer, with completion.
+While in the minibuffer, you can use \\<minibuffer-local-completion-map>\\[minibuffer-complete] and \\[minibuffer-complete-word] to complete your input.
+You can also use \\<minibuffer-local-map>\\[minibuffer-complete-history] to complete using history items in the
+input history HIST, and you can use \\[minibuffer-complete-defaults] to complete using
+the default items in DEFAULT-VALUE.
+
PROMPT is a string to prompt with; normally it ends in a colon and a space.
COLLECTION can be a list of strings, an alist, an obarray or a hash table.
COLLECTION can also be a function to do the completion itself.