diff options
| author | Paul Eggert | 2018-03-20 08:57:40 -0700 |
|---|---|---|
| committer | Paul Eggert | 2018-03-20 08:58:02 -0700 |
| commit | 23527013c79607ba19536ccce85725a91b0033a5 (patch) | |
| tree | dd6c1e7027e93e7180f9460cc76904b74c4967f7 /src | |
| parent | 4328d5f744e032eb4fa67b30bc0ef539f95755c5 (diff) | |
| download | emacs-23527013c79607ba19536ccce85725a91b0033a5.tar.gz emacs-23527013c79607ba19536ccce85725a91b0033a5.zip | |
; Rewrap doc string
Diffstat (limited to 'src')
| -rw-r--r-- | src/minibuf.c | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/src/minibuf.c b/src/minibuf.c index c57182354f0..691fad07b79 100644 --- a/src/minibuf.c +++ b/src/minibuf.c | |||
| @@ -1640,12 +1640,12 @@ PREDICATE limits completion to a subset of COLLECTION. | |||
| 1640 | See `try-completion', `all-completions', `test-completion', | 1640 | See `try-completion', `all-completions', `test-completion', |
| 1641 | and `completion-boundaries', for more details on completion, | 1641 | and `completion-boundaries', for more details on completion, |
| 1642 | COLLECTION, and PREDICATE. See also Info node `(elisp)Basic Completion' | 1642 | COLLECTION, and PREDICATE. See also Info node `(elisp)Basic Completion' |
| 1643 | for the details about completion, and Info node `(elisp)Programmed Completion' for | 1643 | for the details about completion, and Info node `(elisp)Programmed |
| 1644 | expectations from COLLECTION when it's a function. | 1644 | Completion' for expectations from COLLECTION when it's a function. |
| 1645 | 1645 | ||
| 1646 | REQUIRE-MATCH can take the following values: | 1646 | REQUIRE-MATCH can take the following values: |
| 1647 | - t means that the user is not allowed to exit unless | 1647 | - t means that the user is not allowed to exit unless the input is (or |
| 1648 | the input is (or completes to) an element of COLLECTION or is null. | 1648 | completes to) an element of COLLECTION or is null. |
| 1649 | - nil means that the user can exit with any input. | 1649 | - nil means that the user can exit with any input. |
| 1650 | - `confirm' means that the user can exit with any input, but she needs | 1650 | - `confirm' means that the user can exit with any input, but she needs |
| 1651 | to confirm her choice if the input is not an element of COLLECTION. | 1651 | to confirm her choice if the input is not an element of COLLECTION. |
| @@ -1656,19 +1656,19 @@ REQUIRE-MATCH can take the following values: | |||
| 1656 | - anything else behaves like t except that typing RET does not exit if it | 1656 | - anything else behaves like t except that typing RET does not exit if it |
| 1657 | does non-null completion. | 1657 | does non-null completion. |
| 1658 | 1658 | ||
| 1659 | If the input is null, `completing-read' returns DEF, or the first element | 1659 | If the input is null, `completing-read' returns DEF, or the first |
| 1660 | of the list of default values, or an empty string if DEF is nil, | 1660 | element of the list of default values, or an empty string if DEF is |
| 1661 | regardless of the value of REQUIRE-MATCH. | 1661 | nil, regardless of the value of REQUIRE-MATCH. |
| 1662 | 1662 | ||
| 1663 | If INITIAL-INPUT is non-nil, insert it in the minibuffer initially, | 1663 | If INITIAL-INPUT is non-nil, insert it in the minibuffer initially, |
| 1664 | with point positioned at the end. | 1664 | with point positioned at the end. If it is (STRING . POSITION), the |
| 1665 | If it is (STRING . POSITION), the initial input is STRING, but point | 1665 | initial input is STRING, but point is placed at _zero-indexed_ |
| 1666 | is placed at _zero-indexed_ position POSITION in STRING. (*Note* | 1666 | position POSITION in STRING. (*Note* that this is different from |
| 1667 | that this is different from `read-from-minibuffer' and related | 1667 | `read-from-minibuffer' and related functions, which use one-indexing |
| 1668 | functions, which use one-indexing for POSITION.) This feature is | 1668 | for POSITION.) This feature is deprecated--it is best to pass nil |
| 1669 | deprecated--it is best to pass nil for INITIAL-INPUT and supply the | 1669 | for INITIAL-INPUT and supply the default value DEF instead. The |
| 1670 | default value DEF instead. The user can yank the default value into | 1670 | user can yank the default value into the minibuffer easily using |
| 1671 | the minibuffer easily using \\<minibuffer-local-map>\\[next-history-element]. | 1671 | \\<minibuffer-local-map>\\[next-history-element]. |
| 1672 | 1672 | ||
| 1673 | HIST, if non-nil, specifies a history list and optionally the initial | 1673 | HIST, if non-nil, specifies a history list and optionally the initial |
| 1674 | position in the list. It can be a symbol, which is the history list | 1674 | 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 | |||
| 1676 | that case, HISTVAR is the history list variable to use, and HISTPOS | 1676 | that case, HISTVAR is the history list variable to use, and HISTPOS |
| 1677 | is the initial position (the position in the list used by the | 1677 | is the initial position (the position in the list used by the |
| 1678 | minibuffer history commands). For consistency, you should also | 1678 | minibuffer history commands). For consistency, you should also |
| 1679 | specify that element of the history as the value of | 1679 | specify that element of the history as the value of INITIAL-INPUT. |
| 1680 | INITIAL-INPUT. (This is the only case in which you should use | 1680 | (This is the only case in which you should use INITIAL-INPUT instead |
| 1681 | INITIAL-INPUT instead of DEF.) Positions are counted starting from | 1681 | of DEF.) Positions are counted starting from 1 at the beginning of |
| 1682 | 1 at the beginning of the list. The variable `history-length' | 1682 | the list. The variable `history-length' controls the maximum length |
| 1683 | controls the maximum length of a history list. | 1683 | of a history list. |
| 1684 | 1684 | ||
| 1685 | DEF, if non-nil, is the default value or the list of default values. | 1685 | DEF, if non-nil, is the default value or the list of default values. |
| 1686 | 1686 | ||
| 1687 | If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits | 1687 | If INHERIT-INPUT-METHOD is non-nil, the minibuffer inherits the |
| 1688 | the current input method and the setting of `enable-multibyte-characters'. | 1688 | current input method and the setting of `enable-multibyte-characters'. |
| 1689 | 1689 | ||
| 1690 | Completion ignores case if the ambient value of | 1690 | Completion ignores case if the ambient value of |
| 1691 | `completion-ignore-case' is non-nil. | 1691 | `completion-ignore-case' is non-nil. |