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

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

(cherry picked from commit 4be63c85d2a5ec325f6724cb3a78cdcee18094db)

diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index ba811c2e3d459a2fcdab6155815e2e26706a382f..36c1bf46adbcbbd9217b04979de2dad83c3aabec 100644 (file)
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -2125,6 +2125,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