diff options
| author | Eli Zaretskii | 2025-01-11 12:40:59 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2025-01-11 12:40:59 +0200 |
| commit | ee61b9a050b4fbc9940d11bc95437e5113865c8b (patch) | |
| tree | 4dc23b71c670bb4262a27edd59c9a7631749a993 | |
| parent | ce43d13593a44ba36ba6702cf276fef8711ab738 (diff) | |
| download | emacs-ee61b9a050b4fbc9940d11bc95437e5113865c8b.tar.gz 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>.
| -rw-r--r-- | src/minibuf.c | 10 |
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) | |||
| 1293 | DEFUN ("read-from-minibuffer", Fread_from_minibuffer, | 1293 | DEFUN ("read-from-minibuffer", Fread_from_minibuffer, |
| 1294 | Sread_from_minibuffer, 1, 7, 0, | 1294 | Sread_from_minibuffer, 1, 7, 0, |
| 1295 | doc: /* Read a string from the minibuffer, prompting with string PROMPT. | 1295 | doc: /* Read a string from the minibuffer, prompting with string PROMPT. |
| 1296 | While in the minibuffer, you can use \\<minibuffer-local-completion-map>\\[minibuffer-complete] and \\[minibuffer-complete-word] to complete your input. | ||
| 1297 | You can also use \\<minibuffer-local-map>\\[minibuffer-complete-history] to complete using history items in the | ||
| 1298 | input history HIST, and you can use \\[minibuffer-complete-defaults] to complete using | ||
| 1299 | the default items in DEFAULT-VALUE. | ||
| 1300 | |||
| 1301 | The optional second arg INITIAL-CONTENTS is an obsolete alternative to | 1296 | The optional second arg INITIAL-CONTENTS is an obsolete alternative to |
| 1302 | DEFAULT-VALUE. It normally should be nil in new code, except when | 1297 | DEFAULT-VALUE. It normally should be nil in new code, except when |
| 1303 | HIST is a cons. It is discussed in more detail below. | 1298 | 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. */) | |||
| 1983 | 1978 | ||
| 1984 | DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0, | 1979 | DEFUN ("completing-read", Fcompleting_read, Scompleting_read, 2, 8, 0, |
| 1985 | doc: /* Read a string in the minibuffer, with completion. | 1980 | doc: /* Read a string in the minibuffer, with completion. |
| 1981 | While in the minibuffer, you can use \\<minibuffer-local-completion-map>\\[minibuffer-complete] and \\[minibuffer-complete-word] to complete your input. | ||
| 1982 | You can also use \\<minibuffer-local-map>\\[minibuffer-complete-history] to complete using history items in the | ||
| 1983 | input history HIST, and you can use \\[minibuffer-complete-defaults] to complete using | ||
| 1984 | the default items in DEFAULT-VALUE. | ||
| 1985 | |||
| 1986 | PROMPT is a string to prompt with; normally it ends in a colon and a space. | 1986 | PROMPT is a string to prompt with; normally it ends in a colon and a space. |
| 1987 | COLLECTION can be a list of strings, an alist, an obarray or a hash table. | 1987 | COLLECTION can be a list of strings, an alist, an obarray or a hash table. |
| 1988 | COLLECTION can also be a function to do the completion itself. | 1988 | COLLECTION can also be a function to do the completion itself. |