GNU bug report logs - #76199
30.0.93; completing-read-multiple is not documented in the manual

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Daniel Mendler <mail <at> daniel-mendler.de>
Cc: 76199 <at> debbugs.gnu.org
Subject: bug#76199: 30.0.93; completing-read-multiple is not documented in the manual
Date: Tue, 11 Feb 2025 15:51:47 +0200

> From: Daniel Mendler <mail <at> daniel-mendler.de>
> Cc: 76199 <at> debbugs.gnu.org
> Date: Tue, 11 Feb 2025 14:37:56 +0100
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> >> Date: Tue, 11 Feb 2025 11:25:24 +0100
> >> From:  Daniel Mendler via "Bug reports for GNU Emacs,
> >>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> >> 
> >> Since documentation came up in bug#76028, it seems that
> >> `completing-read-multiple' is not documented in the Elisp
> >> manual, in particular in doc/lispref/minibuf.texi.
> >
> > We don't necessarily document every function.  Is this one important
> > enough to be in the manual?
> 
> I think so.

Can you tell why?

The function is documented in its doc string, so adding it to the
manual needs a reason, like extreme popularity (doesn't seem to be the
case here), or some important aspects of its use that cannot be
easily described  in the doc string.

We could also compromise: mention the function's existence in the
manual, but leave out its description (if that will just repeat what's
in the doc string, it's just redundant).

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.