From: Eli Zaretskii <eliz@gnu.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 25794-done@debbugs.gnu.org
Subject: bug#25794: 24.5; Doc of `Info-selection-hook'
Date: Sat, 25 Feb 2017 10:53:49 +0200 [thread overview]
Message-ID: <838touslb6.fsf@gnu.org> (raw)
In-Reply-To: <ec257273-f5f6-474f-9006-7fb5c929cfc3@default> (message from Drew Adams on Sun, 19 Feb 2017 09:28:27 -0800 (PST))
> Date: Sun, 19 Feb 2017 09:28:27 -0800 (PST)
> From: Drew Adams <drew.adams@oracle.com>
>
> This is a hook: a variable used by users to automatically invoke
> functions when something happens.
>
> Sure, it's true that "when something happens" means, more precisely, at
> certain places in the implementation (code). But a hook is a user-level
> thing, and hooks should be, first of all, presented to users as such.
> Their descriptions should make clear to users when they are used.
>
> That's not really the case for `Info-selection-hook', IMO. Why?
> Because users do not know what "when `Info-select-node' is called"
> means. They know nothing about non-interactive function
> `Info-select-node'.
>
> (Also, the doc string says "Hooks run" - that should be singular.)
Fixed on the emacs-25 branch.
Thanks.
prev parent reply other threads:[~2017-02-25 8:53 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-02-19 17:28 bug#25794: 24.5; Doc of `Info-selection-hook' Drew Adams
2017-02-25 8:53 ` Eli Zaretskii [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=838touslb6.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=25794-done@debbugs.gnu.org \
--cc=drew.adams@oracle.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.