; Fix documentation of completion commands
authorEli Zaretskii <eliz@gnu.org>
Sat, 11 Jan 2025 10:40:59 +0000 (12:40 +0200)
committerEli Zaretskii <eliz@gnu.org>
Sat, 11 Jan 2025 10:40:59 +0000 (12:40 +0200)
* 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>.

src/minibuf.c

index e0d060a0480533873615058abbd2172c09b590c6..bf9fad48d88f519d2d09453a50f7a3c97566445a 100644 (file)
@@ -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.  */)
 \f
 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.