summaryrefslogtreecommitdiff
path: root/src/minibuf.c
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2025-03-09 15:02:39 +0200
committerEli Zaretskii <eliz@gnu.org>2025-03-09 15:02:39 +0200
commit59d1aac49dfdc49e34be5964f547db0cfa7e127b (patch)
treed77d8fa81094e38c5117bbe339ee6f13affae12a /src/minibuf.c
parent35c7837c6616b3a2b845ba06d3ed797bb12fb749 (diff)
downloademacs-59d1aac49dfdc49e34be5964f547db0cfa7e127b.tar.gz
emacs-59d1aac49dfdc49e34be5964f547db0cfa7e127b.tar.bz2
emacs-59d1aac49dfdc49e34be5964f547db0cfa7e127b.zip
Document return values of the various read-* functions
* lisp/textmodes/string-edit.el (read-string-from-buffer): * lisp/simple.el (read-from-kill-ring, read-shell-command) (read-signal-name): * lisp/replace.el (read-regexp-case-fold-search): * lisp/auth-source.el (read-passwd): * lisp/subr.el (read-key, read-number): * lisp/minibuffer.el (read-file-name, read-no-blanks-input): * lisp/international/mule-cmds.el (read-multilingual-string): * lisp/language/japan-util.el (read-hiragana-string): * lisp/files-x.el (read-file-local-variable) (read-file-local-variable-mode, read-file-local-variable-value): * lisp/faces.el (read-face-font, read-face-name): * lisp/simple.el (read-extended-command): * lisp/env.el (read-envvar-name): * lisp/files.el (read-directory-name): * lisp/faces.el (read-color): * lisp/international/mule-diag.el (read-charset): * lisp/emacs-lisp/map-ynp.el (read-answer): * src/coding.c (Fread_coding_system) (Fread_non_nil_coding_system): * src/minibuf.c (Fread_command, Fread_from_minibuffer): * src/lread.c (Fread_char, Fread_char_exclusive, Fread_event): Doc fixes.
Diffstat (limited to 'src/minibuf.c')
-rw-r--r--src/minibuf.c4
1 files changed, 2 insertions, 2 deletions
diff --git a/src/minibuf.c b/src/minibuf.c
index 026a8f4271e..3cb7ff47030 100644
--- a/src/minibuf.c
+++ b/src/minibuf.c
@@ -1292,7 +1292,7 @@ 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.
+ doc: /* Read and return a string from the minibuffer, prompting with string PROMPT.
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.
@@ -1444,7 +1444,7 @@ inherits the current input method and the setting of
}
DEFUN ("read-command", Fread_command, Sread_command, 1, 2, 0,
- doc: /* Read the name of a command and return as a symbol.
+ doc: /* Read the name of a command and return it as a symbol.
Prompt with PROMPT. By default, return DEFAULT-VALUE or its first element
if it is a list. If DEFAULT-VALUE is omitted or nil, and the user enters
null input, return a symbol whose name is an empty string. */)