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

Improve documentation of COLLECTION in completion functions

Browse source 
* doc/lispref/minibuf.texi (Minibuffer Completion): Add a
cross-reference to "Programmed Completion".

* src/minibuf.c (Fcompleting_read): Improve the doc string.
(Bug#21644)
This commit is contained in:
Eli Zaretskii 2015-10-16 12:38:36 +03:00
parent 3000d33c5d
commit d05410f349
2 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/lispref/minibuf.texi
View file

@ -975,6 +975,9 @@ Thus, if @var{predicate} is non-@code{nil}, it should be compatible
with @var{collection} and @code{completion-ignore-case}.
@xref{Definition of test-completion}.
@xref{Programmed Completion}, for detailed requirements when
@var{collection} is a function.
The value of the optional argument @var{require-match} determines how
the user may exit the minibuffer:

7
src/minibuf.c
View file

@ -1595,8 +1595,11 @@ PROMPT is a string to prompt with; normally it ends in a colon and a space.
COLLECTION can be a list of strings, an alist, an obarray or a hash table.
COLLECTION can also be a function to do the completion itself.
PREDICATE limits completion to a subset of COLLECTION.
See Info node `(elisp)Basic Completion' for more details
on completion, COLLECTION, and PREDICATE.
See `try-completion', `all-completions', `test-completion',
and `completion-boundaries', for more details on completion,
COLLECTION, and PREDICATE. See also Info nodes `(elisp)Basic Completion'
for the details about completion, and `(elisp)Programmed Completion' for
expectations from COLLECTION when it's a function.
REQUIRE-MATCH can take the following values:
- t means that the user is not allowed to exit unless