; Document 'completing-read-multiple' in the ELisp manual
authorEli Zaretskii <eliz@gnu.org>
Tue, 11 Feb 2025 14:42:19 +0000 (16:42 +0200)
committerEli Zaretskii <eliz@gnu.org>
Tue, 11 Feb 2025 14:42:19 +0000 (16:42 +0200)
* doc/lispref/minibuf.texi (Minibuffer Completion): Mention
'completing-read-multiple' (bug#76194).

doc/lispref/minibuf.texi

index 43e87f89aee1afe2b5fb84859450935ca45aff2f..9bff31aaf3c05ffaea013eff96d2755e9dbdf127 100644 (file)
@@ -1249,6 +1249,16 @@ different function to completely override the normal behavior of
 @code{completing-read}.
 @end defvar
 
+@findex completing-read-multiple
+@vindex crm-separator
+If you need to prompt the user for several strings, like several
+elements of a list or several parameters (e.g., user, host, and port) of
+a connection, you can use @code{completing-read-multiple}.  It allows
+typing several strings separated by a separator string (by default, tabs
+and commas; customize @code{crm-separator} to change that), and provides
+completion for each individual string the user types.  It returns the
+strings that were read, as a list.
+
 @node Completion Commands
 @subsection Minibuffer Commands that Do Completion