Document return values of the various read-* functions
authorEli Zaretskii <eliz@gnu.org>
Sun, 9 Mar 2025 13:02:39 +0000 (15:02 +0200)
committerEshel Yaron <me@eshelyaron.com>
Wed, 12 Mar 2025 18:46:09 +0000 (19:46 +0100)
commit2c664ce0e5475d9e62bc109c3e09c1801722a3f7
tree711f5941828389b2511255097d0bcc4ddc396367
parent7b9a0d4924406a4659bc290d2956126f259e87d2
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.

(cherry picked from commit 59d1aac49dfdc49e34be5964f547db0cfa7e127b)
14 files changed:
lisp/emacs-lisp/map-ynp.el
lisp/env.el
lisp/faces.el
lisp/files-x.el
lisp/international/mule-cmds.el
lisp/international/mule-diag.el
lisp/language/japan-util.el
lisp/replace.el
lisp/simple.el
lisp/subr.el
lisp/textmodes/string-edit.el
src/coding.c
src/lread.c
src/minibuf.c