all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Dmitry Gutov <dgutov@yandex.ru>,
	"Ryan C. Thompson" <rct@thompsonclan.org>,
	Oleh Krehel <ohwoeowho@gmail.com>
Cc: 21644@debbugs.gnu.org
Subject: bug#21644: 24.4; completing-read acts differently on functional collection
Date: Thu, 15 Oct 2015 08:01:03 -0700 (PDT)	[thread overview]
Message-ID: <c92dc5c7-bf93-4040-9da1-96b1a57b560a@default> (raw)
In-Reply-To: <561F35AD.8000803@yandex.ru>

> >> (info "(elisp) Programmed Completion") or
> >> (info "(elisp) Basic Completion"), probably.
> > Maybe the `completing-read' docstring should link to these info nodes.
> 
> This seems like it should suffice. Do you agree?
> +See Info node `(elisp)Basic Completion' for more details
>    on completion, COLLECTION, and PREDICATE.

Yes and no, IMO.  `Basic Completion' certainly provides
some information about "completion, COLLECTION, and
PREDICATE."  But for 3 other functions, not explicitly
for `completing-read' - it is not even mentioned there.

To understand COLLECTION for `completing-read', that node
not the best place to go.

As was suggested earlier (see above), node `Programmed
Completion' is where we should send someone for information
about a function-valued COLLECTION argument.

It doesn't hurt to send them to both nodes or to only
their parent, `Completion'.  But it is not clear to me
that someone trying to use `completing-read' with a
function-valued COLLECTION will understand what is
needed just from `Basic Completion'.

Especially since the `completing-read' doc string
mentions only `all-completions' and `try-completion',
not `test-completion' (which is OK): Someone going to
`Basic Completion' to find out more about parameter
COLLECTION for  `completing-read' is likely to miss
the description of COLLECTION for `test-completion'
or to think that it is not relevant.

A priori, there is nothing that necessarily connects
the COLLECTION parameter of `completing-read' with
the COLLECTION parameters of those 3 more-basic
functions, or even that connects those 3 COLLECTION
parameters.  That is, just giving them the same
name is not sufficient to specify that they are the
same.

Just saying to go see `Basic Completion' for info
about COLLECTION etc. _suggests_ that there is a
connection, but, again, that doesn't mean that
someone will see the relevance of `test-completion'
here.






  parent reply	other threads:[~2015-10-15 15:01 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-07 22:55 bug#21644: 24.4; completing-read acts differently on functional collection Ryan C. Thompson
2015-10-08 10:13 ` Oleh Krehel
2015-10-13  1:23   ` Dmitry Gutov
2015-10-13  1:34     ` Ryan
2015-10-13  2:27       ` Dmitry Gutov
2015-10-13 18:59         ` Ryan C. Thompson
2015-10-15  5:12           ` Dmitry Gutov
2015-10-15  5:17             ` Ryan
2015-10-15  9:18               ` Dmitry Gutov
2015-10-15 15:01             ` Drew Adams [this message]
2015-10-15 15:24               ` Dmitry Gutov
2015-10-15 16:47                 ` Drew Adams
2015-10-15 17:03                   ` Dmitry Gutov
2015-10-15 20:28                     ` Drew Adams
2015-10-15 21:07                       ` Dmitry Gutov
2015-10-16  9:45                         ` Eli Zaretskii
2015-10-16 10:24                           ` Dmitry Gutov
2015-10-16  9:46                         ` Eli Zaretskii
2015-10-16  9:54                           ` Dmitry Gutov
2015-10-16 13:12                           ` Stefan Monnier
2015-10-16 13:44                             ` Eli Zaretskii
2015-10-16 14:03                               ` Stefan Monnier
2015-10-16 13:12       ` Stefan Monnier
     [not found] <<5615A2EA.4@thompsonclan.org>
     [not found] ` <<87vbahmzwd.fsf@gmail.com>
     [not found]   ` <<561C5D0B.9070303@yandex.ru>
     [not found]     ` <<561C5FB0.6030105@thompsonclan.org>
     [not found]       ` <<561C6C12.20803@yandex.ru>
     [not found]         ` <<561D54AF.7090701@thompsonclan.org>
     [not found]           ` <<561F35AD.8000803@yandex.ru>
     [not found]             ` <<c92dc5c7-bf93-4040-9da1-96b1a57b560a@default>
     [not found]               ` <<561FC52F.1010606@yandex.ru>
     [not found]                 ` <<4fe19dae-4269-401b-82bd-10f9d368a921@default>
     [not found]                   ` <<561FDC63.6010609@yandex.ru>
     [not found]                     ` <<917e38a9-d74b-4e41-bc7b-90aeee69584c@default>
     [not found]                       ` <<5620159C.3060401@yandex.ru>
     [not found]                         ` <<837fmn6tb3.fsf@gnu.org>
2015-10-16 15:53                           ` Drew Adams

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=c92dc5c7-bf93-4040-9da1-96b1a57b560a@default \
    --to=drew.adams@oracle.com \
    --cc=21644@debbugs.gnu.org \
    --cc=dgutov@yandex.ru \
    --cc=ohwoeowho@gmail.com \
    --cc=rct@thompsonclan.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.