From: Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Tomas Nordin <tomasn@posteo.net>, 72915@debbugs.gnu.org
Subject: bug#72915: Docstrings of add-hook and remove-hook improvement?
Date: Sun, 01 Sep 2024 10:34:19 -0400 [thread overview]
Message-ID: <jwvzforo3tv.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <86y14c9dk3.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 01 Sep 2024 07:57:00 +0300")
>> -HOOK should be a symbol. If HOOK is void, it is first set to
>> -nil. If HOOK's value is a single function, it is changed to a
>> -list of functions.
> Is the bit about setting HOOK to nil incorrect? Because the new text
> drops that part.
That's an internal detail that's not observable to the caller anyway.
>> "Remove from the value of HOOK the function FUNCTION.
>> HOOK should be a symbol, and FUNCTION may be any valid function. If
>> FUNCTION isn't the value of HOOK, or, if FUNCTION doesn't appear in the
>> -list of hooks to run in HOOK, then nothing is done. See `add-hook'.
>> +list of functions to run in HOOK, then nothing is done. See `add-hook'.
>
> "list of functions to run in HOOK" is ambiguous wrt what "in HOOK"
> refers to. I would rephrase:
>
> If FUNCTION is not the value of HOOK and is not a member of the list
> that is the value of HOOK, do nothing.
Maybe we can simplify the wording a bit by focusing less about whether
the hook's value is a function or a list of functions, and talking about
the "sequence" or "set" of functions (which can be represented by
a list of functions or a function)?
Something like:
"Remove FUNCTION from HOOK's functions.
HOOK should be a symbol, and FUNCTION may be any valid function.
Does nothing if HOOK does not currently contain FUNCTION.
Compares functions with `equal`, which means that it can be
slow if FUNCTION is not a symbol. See `add-hook'.
- Stefan
next prev parent reply other threads:[~2024-09-01 14:34 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-31 12:36 bug#72915: Docstrings of add-hook and remove-hook improvement? Tomas Nordin
2024-08-31 22:35 ` Stefan Kangas
2024-09-01 4:57 ` Eli Zaretskii
2024-09-01 7:15 ` Stefan Kangas
2024-09-01 7:18 ` Stefan Kangas
2024-09-01 14:17 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-09-01 15:47 ` Tomas Nordin
2024-09-14 13:31 ` Stefan Kangas
2024-09-01 14:34 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors [this message]
2024-09-14 23:24 ` Stefan Kangas
2024-09-15 11:17 ` Tomas Nordin
2024-09-15 13:19 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-09-15 13:49 ` Tomas Nordin
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=jwvzforo3tv.fsf-monnier+emacs@gnu.org \
--to=bug-gnu-emacs@gnu.org \
--cc=72915@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=monnier@iro.umontreal.ca \
--cc=tomasn@posteo.net \
/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.