Re: emacs-30 8064b2a6798: Document undocumented completion commands

[Eshel Yaron]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Eshel Yaron <me@eshelyaron.com>
>> Cc: emacs-devel@gnu.org
>> Date: Mon, 06 Jan 2025 13:16:40 +0100
>> 
>> Eli Zaretskii <eliz@gnu.org> writes:
>> 
>> >> From: Eshel Yaron <me@eshelyaron.com>
>> >> Cc: emacs-devel@gnu.org
>> >> Date: Sun, 05 Jan 2025 12:36:27 +0100
>> >> 
>> >> Eli Zaretskii <eliz@gnu.org> writes:
>> >> 
>> >> >> From: Eshel Yaron <me@eshelyaron.com>
>> >> >> Cc: Eli Zaretskii <eliz@gnu.org>
>> >> >> Date: Sun, 05 Jan 2025 09:06:04 +0100
>> >> >> 
>> >> >> >  DEFUN ("read-from-minibuffer", Fread_from_minibuffer,
>> >> >> >         Sread_from_minibuffer, 1, 7, 0,
>> >> >> >         doc: /* Read a string from the minibuffer, prompting with 
>> >> >> > string PROMPT.
>> >> >> > +While in the minibuffer, you can use 
>> >> >> > \\<minibuffer-local-completion-map>\\[minibuffer-complete] and 
>> >> >> > \\[minibuffer-complete-word] to complete your input.
>> >> >> 
>> >> >> This part isn't quite right: read-from-minibuffer does not provide
>> >> >> completion with minibuffer-complete[-word] by default.
>> >> >> 
>> >> >> How about just dropping these references?
>> >> >
>> >> > Sorry, I don't want to drop them, they are important.
>> >> >
>> >> > Why do you say these are not supported by default?  I can use them in
>> >> > "emacs -Q", so what did I miss?
>> >> 
>> >> Hmm, C-h f read-from-minibuffer now says "While in the minibuffer, you can
>> >> use TAB and SPC to complete your input."  But read-from-minibuffer doesn't
>> >> provide such completion, by default it uses minibuffer-local-map, in which
>> >> both keys are self-inserting.  Do you see something different?
>> >
>> > Please help me make this accurate without losing the important
>> > information about these commands.  Okay?
>> 
>> AFAICT it would be more accurate (and relevant) to mention these
>> commands in the docstring of completing-read, not read-from-minibuffer.
>> But they are also pretty well documented in both the Emacs manual and
>> the ELisp manual, so I'm not sure I see the importance of mentioning
>> them there as well...
>
> Maybe you are right.  But can you help me a bit more by telling which
> functions that enter the minibuffer install the two keymaps I
> mentioned in the doc string, minibuffer-local-map and
> minibuffer-local-completion-map?  Those are the functions in whose
> minibuffer these commands can be used.

Sure: essentially all functions that enter the minibuffer install
minibuffer-local-map or a map that inherits from minibuffer-local-map.

minibuffer-local-completion-map is specific to completing-read-default,
the default completing-read-function which completing-read invokes.


Eshel