procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Rewrap doc string

Browse source
This commit is contained in:
Paul Eggert 2018-03-20 08:57:40 -07:00
parent 4328d5f744
commit 23527013c7
1 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
src/minibuf.c
View file

@ -1640,12 +1640,12 @@ PREDICATE limits completion to a subset of COLLECTION.
See `try-completion', `all-completions', `test-completion', See `try-completion', `all-completions', `test-completion',
and `completion-boundaries', for more details on completion, and `completion-boundaries', for more details on completion,
COLLECTION, and PREDICATE. See also Info node `(elisp)Basic Completion' COLLECTION, and PREDICATE. See also Info node `(elisp)Basic Completion'
for the details about completion, and Info node `(elisp)Programmed Completion' for for the details about completion, and Info node `(elisp)Programmed
expectations from COLLECTION when it's a function. Completion' for expectations from COLLECTION when it's a function.
REQUIRE-MATCH can take the following values: REQUIRE-MATCH can take the following values:
- t means that the user is not allowed to exit unless - t means that the user is not allowed to exit unless the input is (or
the input is (or completes to) an element of COLLECTION or is null. completes to) an element of COLLECTION or is null.
- nil means that the user can exit with any input. - nil means that the user can exit with any input.
- `confirm' means that the user can exit with any input, but she needs - `confirm' means that the user can exit with any input, but she needs
to confirm her choice if the input is not an element of COLLECTION. to confirm her choice if the input is not an element of COLLECTION.
@ -1656,19 +1656,19 @@ REQUIRE-MATCH can take the following values:
- anything else behaves like t except that typing RET does not exit if it - anything else behaves like t except that typing RET does not exit if it
does non-null completion. does non-null completion.
If the input is null, `completing-read' returns DEF, or the first element If the input is null, `completing-read' returns DEF, or the first
of the list of default values, or an empty string if DEF is nil, element of the list of default values, or an empty string if DEF is
regardless of the value of REQUIRE-MATCH. nil, regardless of the value of REQUIRE-MATCH.
If INITIAL-INPUT is non-nil, insert it in the minibuffer initially, If INITIAL-INPUT is non-nil, insert it in the minibuffer initially,
with point positioned at the end. with point positioned at the end. If it is (STRING . POSITION), the
If it is (STRING . POSITION), the initial input is STRING, but point initial input is STRING, but point is placed at _zero-indexed_
is placed at _zero-indexed_ position POSITION in STRING. (*Note* position POSITION in STRING. (*Note* that this is different from
that this is different from `read-from-minibuffer' and related `read-from-minibuffer' and related functions, which use one-indexing
functions, which use one-indexing for POSITION.) This feature is for POSITION.) This feature is deprecated--it is best to pass nil
deprecated--it is best to pass nil for INITIAL-INPUT and supply the for INITIAL-INPUT and supply the default value DEF instead. The
default value DEF instead. The user can yank the default value into user can yank the default value into the minibuffer easily using
the minibuffer easily using \\<minibuffer-local-map>\\[next-history-element]. \\<minibuffer-local-map>\\[next-history-element].
HIST, if non-nil, specifies a history list and optionally the initial HIST, if non-nil, specifies a history list and optionally the initial
position in the list. It can be a symbol, which is the history list position in the list. It can be a symbol, which is the history list
@ -1676,16 +1676,16 @@ HIST, if non-nil, specifies a history list and optionally the initial
that case, HISTVAR is the history list variable to use, and HISTPOS that case, HISTVAR is the history list variable to use, and HISTPOS
is the initial position (the position in the list used by the is the initial position (the position in the list used by the
minibuffer history commands). For consistency, you should also minibuffer history commands). For consistency, you should also
specify that element of the history as the value of specify that element of the history as the value of INITIAL-INPUT.
INITIAL-INPUT. (This is the only case in which you should use (This is the only case in which you should use INITIAL-INPUT instead
INITIAL-INPUT instead of DEF.) Positions are counted starting from of DEF.) Positions are counted starting from 1 at the beginning of
1 at the beginning of the list. The variable `history-length' the list. The variable `history-length' controls the maximum length
controls the maximum length of a history list. of a history list.
DEF, if non-nil, is the default value or the list of default values. DEF, if non-nil, is the default value or the list of default values.
If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits the
the current input method and the setting of `enable-multibyte-characters'. current input method and the setting of `enable-multibyte-characters'.
Completion ignores case if the ambient value of Completion ignores case if the ambient value of
`completion-ignore-case' is non-nil. `completion-ignore-case' is non-nil.