; Document 'completion-table-with-metadata' in the ELisp manual

* doc/lispref/minibuf.texi (Programmed Completion): Document
'completion-table-with-metadata'.

1 files changed, 9 insertions, 0 deletions

diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index 3cc206d2e1d..6222809d0dc 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -2123,6 +2123,15 @@ same argument only need to call @var{function} once.  This can be useful
 when a slow operation is involved, such as calling an external process.
 @end defun
 
+@defun completion-table-with-metadata table metadata
+This function creates a completion table that behaves like the existing
+completion table @var{table}, except with additional metadata, specified
+by the completion metadata alist @var{metadata}.  If @var{table} already
+provides completion metadata, that metadata is merged with
+@var{metadata}, giving precedence to @var{metadata} in case an entry
+appears both.
+@end defun
+
 @node Completion in Buffers
 @subsection Completion in Ordinary Buffers
 @cindex inline completion