diff options
| author | Chong Yidong | 2012-10-05 15:48:25 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-10-05 15:48:25 +0800 |
| commit | 379acb951495d947ff42da6fc79b39f2e5f2f623 (patch) | |
| tree | 18afac31f34fd6e4c3e380744429bf94ebb46302 | |
| parent | e8757f091a502b858912a4c267210e009227d6e6 (diff) | |
| download | emacs-379acb951495d947ff42da6fc79b39f2e5f2f623.tar.gz emacs-379acb951495d947ff42da6fc79b39f2e5f2f623.zip | |
* minibuf.texi (Basic Completion): Clarify list form of completion table.
Fixes: debbugs:12564
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/minibuf.texi | 29 |
2 files changed, 18 insertions, 16 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 8568b024f67..7609efb8ac9 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2012-10-05 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | * minibuf.texi (Basic Completion): Clarify list form of completion | ||
| 4 | table (Bug#12564). | ||
| 5 | |||
| 1 | 2012-10-05 Bruno Félix Rezende Ribeiro <oitofelix@gmail.com> (tiny change) | 6 | 2012-10-05 Bruno Félix Rezende Ribeiro <oitofelix@gmail.com> (tiny change) |
| 2 | 7 | ||
| 3 | * functions.texi (Function Safety): Copyedit. (Bug#12562) | 8 | * functions.texi (Function Safety): Copyedit. (Bug#12562) |
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index 3d6e80bf3f0..39b4fca3b25 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi | |||
| @@ -664,25 +664,22 @@ This function returns the longest common substring of all possible | |||
| 664 | completions of @var{string} in @var{collection}. | 664 | completions of @var{string} in @var{collection}. |
| 665 | 665 | ||
| 666 | @cindex completion table | 666 | @cindex completion table |
| 667 | The @var{collection} argument is called the @dfn{completion table}. | 667 | @var{collection} is called the @dfn{completion table}. Its value must |
| 668 | Its value must be a list of strings, an alist whose keys are strings | 668 | be a list of strings or cons cells, an obarray, a hash table, or a |
| 669 | or symbols, an obarray, a hash table, or a completion function. | 669 | completion function. |
| 670 | 670 | ||
| 671 | Completion compares @var{string} against each of the permissible | 671 | @code{try-completion} compares @var{string} against each of the |
| 672 | completions specified by @var{collection}. If no permissible | 672 | permissible completions specified by the completion table. If no |
| 673 | completions match, @code{try-completion} returns @code{nil}. If there | 673 | permissible completions match, it returns @code{nil}. If there is |
| 674 | is just one matching completion, and the match is exact, it returns | 674 | just one matching completion, and the match is exact, it returns |
| 675 | @code{t}. Otherwise, it returns the longest initial sequence common | 675 | @code{t}. Otherwise, it returns the longest initial sequence common |
| 676 | to all possible matching completions. | 676 | to all possible matching completions. |
| 677 | 677 | ||
| 678 | If @var{collection} is an alist (@pxref{Association Lists}), the | 678 | If @var{collection} is an list, the permissible completions are |
| 679 | permissible completions are the elements of the alist that are either | 679 | specified by the elements of the list, each of which should be either |
| 680 | strings, or conses whose @sc{car} is a string or symbol. | 680 | a string, or a cons cell whose @sc{car} is either a string or a symbol |
| 681 | Symbols are converted to strings using @code{symbol-name}. Other | 681 | (a symbol is converted to a string using @code{symbol-name}). If the |
| 682 | elements of the alist are ignored. (Remember that in Emacs Lisp, the | 682 | list contains elements of any other type, those are ignored. |
| 683 | elements of alists do not @emph{have} to be conses.) In particular, a | ||
| 684 | list of strings is allowed, even though we usually do not | ||
| 685 | think of such lists as alists. | ||
| 686 | 683 | ||
| 687 | @cindex obarray in completion | 684 | @cindex obarray in completion |
| 688 | If @var{collection} is an obarray (@pxref{Creating Symbols}), the names | 685 | If @var{collection} is an obarray (@pxref{Creating Symbols}), the names |