From: nljlistbox2@gmail.com (N. Jackson)
To: Leo Liu <sdl.web@gmail.com>
Cc: 16687@debbugs.gnu.org
Subject: bug#16687: 24.3.50; completion doc errors
Date: Wed, 23 Mar 2016 13:01:34 -0300 [thread overview]
Message-ID: <87d1qlgp41.fsf@gmail.com> (raw)
In-Reply-To: <m1ob2i9vyi.fsf@gmail.com> (Leo Liu's message of "Sat, 08 Feb 2014 10:31:17 +0800")
Hi Leo,
At 09:31 +0800 on Saturday 2014-02-08, Leo Liu wrote:
>
> The doc disagrees with the function's doc-string:
>
> ,----[ (info "(elisp)Completion Variables") ]
> | The TRY-COMPLETION and ALL-COMPLETIONS functions should each
> | accept four arguments: STRING, COLLECTION, PREDICATE, and
> | POINT. The STRING, COLLECTION, and PREDICATE arguments have
> | the same meanings as in `try-completion' (*note Basic
> | Completion::), and the POINT argument is the position of
> | point within STRING. Each function should return a non-`nil'
> | value if it performed its job, and `nil' if it did not (e.g.,
> | if there is no way to complete STRING according to the
> | completion style).
> `----
To which function are you referring? This is the doc of the _variable_
`completion-styles-alist'.
If you mean the function `try-completion', the doc doesn't say that
the TRY-COMPLETION and ALL-COMPLETIONS functions should have the same
"signature" as `try-completion', only that their arguments named
STRING, COLLECTION, and PREDICATE have the same meaning as the
arguments, with the same names, to `try-completion'.
The docstring of `try-completion' indeed documents the meaning of
these three arguments and I don't see any obvious inconsistency there.
Can you be more specific about the inconsistency you see?
> It seems this should be `five' instead of `four':
>
> ,----[ (info "(elisp)Programmed Completion") ]
> | * A flag specifying the type of completion operation to
> | perform. This is one of the following four values:
> `----
This bit of documention now reads:
• A flag specifying the type of completion operation to perform.
This flag may be one of the following values.
So this part of the bug is now fixed. :)
N.
prev parent reply other threads:[~2016-03-23 16:01 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-02-08 2:31 bug#16687: 24.3.50; completion doc errors Leo Liu
2016-03-23 16:01 ` N. Jackson [this message]
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=87d1qlgp41.fsf@gmail.com \
--to=nljlistbox2@gmail.com \
--cc=16687@debbugs.gnu.org \
--cc=sdl.web@gmail.com \
/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.