Update documentation of 'completion-table-dynamic'

* doc/lispref/minibuf.texi (Programmed Completion): Document the
new optional argument to 'completion-table-dynamic'.

diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index ead4fe982dc646814af7ad20ab36e90fcdeef0d4..e24d2cd643a3cdcaabd521279d6a8d1ece1c5bbd 100644 (file)
--- 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

diff --git a/etc/NEWS b/etc/NEWS
index 029e9d8392fa2b63434e256ac04fe8fc896b99aa..34c489a1a3c42a8dc4aeb7b8eeb34f13e9e1ba53 100644 (file)
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1225,10 +1225,12 @@ Use `save-mark-and-excursion' if you want the old behavior.
 ** `read-buffer' and `read-buffer-function' can now be called with a 4th
 argument (`predicate').
 
-** completion-table-dynamic stays in the minibuffer.
++++
+** `completion-table-dynamic' by default stays in the minibuffer.
+The minibuffer will be the current buffer when the function is called.
 If you want the old behavior of calling the function in the buffer
-from which the minibuffer was entered, call it with the new argument
-`switch-buffer'.
+from which the minibuffer was entered, use the new argument
+`switch-buffer' to `completion-table-dynamic'.
 
 ** window-configurations no longer record the buffers' marks.