From bba8c532fa025a3efffdcccd40bfe66a4e9effd2 Mon Sep 17 00:00:00 2001
From: Eli Zaretskii
Date: Tue, 12 Jan 2016 21:10:09 +0200
Subject: Update documentation of 'completion-table-dynamic'

* doc/lispref/minibuf.texi (Programmed Completion): Document the
new optional argument to 'completion-table-dynamic'.
---
 doc/lispref/minibuf.texi | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

(limited to 'doc')

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
 the same as for @code{display-sort-function}.
 @end table
 
-@defun completion-table-dynamic function
+@defun completion-table-dynamic function &optional switch-buffer
 This function is a convenient way to write a function that can act as
 a programmed completion function.  The argument @var{function} should be
 a function that takes one argument, a string, and returns an alist of
-possible completions of it.  You can think of
+possible completions of it.  It is allowed to ignore the argument and
+return a full list of all possible completions.  You can think of
 @code{completion-table-dynamic} as a transducer between that interface
 and the interface for programmed completion functions.
+
+If the optional argument @var{switch-buffer} is non-@code{nil}, and
+completion is performed in the minibuffer, @var{function} will be
+called with current buffer set to the buffer from which the minibuffer
+was entered.
 @end defun
 
 @defun completion-table-with-cache function &optional ignore-case
-- 
cgit v1.2.1