diff options
| author | Eli Zaretskii | 2016-01-12 21:10:09 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2016-01-12 21:10:09 +0200 |
| commit | bba8c532fa025a3efffdcccd40bfe66a4e9effd2 (patch) | |
| tree | 32852f3f065e400709856bccf0e313171d4c305e /doc | |
| parent | e879070d8c329e4e7ccbd6687ef577589faedcf1 (diff) | |
| download | emacs-bba8c532fa025a3efffdcccd40bfe66a4e9effd2.tar.gz emacs-bba8c532fa025a3efffdcccd40bfe66a4e9effd2.zip | |
Update documentation of 'completion-table-dynamic'
* doc/lispref/minibuf.texi (Programmed Completion): Document the
new optional argument to 'completion-table-dynamic'.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/minibuf.texi | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi index ead4fe982dc..e24d2cd643a 100644 --- a/doc/lispref/minibuf.texi +++ b/doc/lispref/minibuf.texi | |||
| @@ -1818,13 +1818,19 @@ emacs, The GNU Emacs Manual}. Its argument list and return value are | |||
| 1818 | the same as for @code{display-sort-function}. | 1818 | the same as for @code{display-sort-function}. |
| 1819 | @end table | 1819 | @end table |
| 1820 | 1820 | ||
| 1821 | @defun completion-table-dynamic function | 1821 | @defun completion-table-dynamic function &optional switch-buffer |
| 1822 | This function is a convenient way to write a function that can act as | 1822 | This function is a convenient way to write a function that can act as |
| 1823 | a programmed completion function. The argument @var{function} should be | 1823 | a programmed completion function. The argument @var{function} should be |
| 1824 | a function that takes one argument, a string, and returns an alist of | 1824 | a function that takes one argument, a string, and returns an alist of |
| 1825 | possible completions of it. You can think of | 1825 | possible completions of it. It is allowed to ignore the argument and |
| 1826 | return a full list of all possible completions. You can think of | ||
| 1826 | @code{completion-table-dynamic} as a transducer between that interface | 1827 | @code{completion-table-dynamic} as a transducer between that interface |
| 1827 | and the interface for programmed completion functions. | 1828 | and the interface for programmed completion functions. |
| 1829 | |||
| 1830 | If the optional argument @var{switch-buffer} is non-@code{nil}, and | ||
| 1831 | completion is performed in the minibuffer, @var{function} will be | ||
| 1832 | called with current buffer set to the buffer from which the minibuffer | ||
| 1833 | was entered. | ||
| 1828 | @end defun | 1834 | @end defun |
| 1829 | 1835 | ||
| 1830 | @defun completion-table-with-cache function &optional ignore-case | 1836 | @defun completion-table-with-cache function &optional ignore-case |