GNU bug report logs - #21644
24.4; completing-read acts differently on functional collection

Previous Next

Package: emacs;

Reported by: "Ryan C. Thompson" <rct <at> thompsonclan.org>

Date: Wed, 7 Oct 2015 22:57:01 UTC

Severity: normal

Found in version 24.4

Done: Dmitry Gutov <dgutov <at> yandex.ru>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Dmitry Gutov <dgutov <at> yandex.ru>
Cc: 21644 <at> debbugs.gnu.org, rct <at> thompsonclan.org, drew.adams <at> oracle.com, ohwoeowho <at> gmail.com
Subject: bug#21644: 24.4; completing-read acts differently on functional collection
Date: Fri, 16 Oct 2015 12:45:04 +0300

> From: Dmitry Gutov <dgutov <at> yandex.ru>
> Date: Fri, 16 Oct 2015 00:07:40 +0300
> Cc: 21644 <at> debbugs.gnu.org
> 
> On 10/15/2015 11:28 PM, Drew Adams wrote:
> 
> > No one has said anything that would introduce another bug.
> > It's about fixing this bug, by getting users to the information
> > about function-valued COLLECTION.  And that info is in node
> > `Programmed Completion'.
> >
> > No one has said that users should not consult `Basic Completion'
> > for info about `all-completions', `try-completion', and
> > `test-completion'.
> 
> The current sentence that refers to the Info node would become wrong. 
> But I suppose an alternative wording might escape that problem.
> 
> Patch welcome.

Done.

> > Really what should be done is to link from the `completing-read'
> > doc string only to node `Minibuffer Completion', which is the
> > node that documents `completing-read'.
> 
> I don't know about that: that page basically re-tells the docstring of 
> completing-read. Sending to it from that docstring seems redundant.

I agree.

> > It is a bug (IMHO) that the node that documents `completing-read'
> > does not specify parameter COLLECTION - which is arguably the
> > *most important* parameter.
> 
> You're probably right. Please send a patch.

Done.

I also re-added the references to the completion functions into the
doc string of completing-read (and added 2 more functions to that
list).  While referencing the manual is good, especially for complex
topics, I feel that the absolute minimum of usage information,
including the arguments with which callbacks can be called, should be
available from the doc strings.
This bug report was last modified 9 years and 221 days ago.

Previous Next

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