emacs-pretest-bug
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

RE: doc for try-completion etc. conflicts with doc for completing-read


From: Drew Adams
Subject: RE: doc for try-completion etc. conflicts with doc for completing-read
Date: Sat, 27 Jan 2007 10:16:04 -0800

> > The doc for `completing-read-multiple' refers you to the doc of
> > `completing-read' for explanation of arg TABLE. Click the
> > `completing-read' link.
> >
> > The doc for `completing-read' refers you to the doc for
> > `try-completion' etc. for explanation of arg TABLE. Click the
> > `try-completion' link.
> >
> > The doc for `try-completion' does not mention TABLE; it mentions
> > ALIST.  In sum, we send users to the doc of `try-completion' etc. for
> > info about TABLE, but they cannot find its explanation there.
> >
> > Please change the doc of `try-completion' etc. to use TABLE, not
> > ALIST, for consistency.
>
> Thanks.
>
> I didn't want to rename the argument so close to the release, so I
> added a few more words to the doc string of completing-read, and
> mentioned the fact that TABLE is called ALIST in try-completion and
> all-completions.

Thanks. `test-completion' is in the same boat, BTW.

Please make a note somewhere (e.g. TODO) that the right fix, after the
release, is to rename the parameter to "TABLE", in each of `try-completion',
`test-completion', and `all-completions'.

Today, `completing-read-multiple' refers to `completing-read' for an
explanation of TABLE, so you need only tweak the doc of `completing-read'.
But tomorrow someone might refer `completing-read-multiple' directly to
`try-completion' or `test-completion' or `all-completions'. If that happens,
the problem will resurface.

IOW, if the fix is made where we send people elsewhere for the explanation,
then it needs to be made everywhere we might do that. If the fix (renaming)
is made at the target, not the source, then there is no such problem.







reply via email to

[Prev in Thread] Current Thread [Next in Thread]