From: Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
To: Tomas Nordin <tomasn@posteo.net>
Cc: Eli Zaretskii <eliz@gnu.org>,
Stefan Kangas <stefankangas@gmail.com>,
72915@debbugs.gnu.org
Subject: bug#72915: Docstrings of add-hook and remove-hook improvement?
Date: Sun, 15 Sep 2024 09:19:43 -0400 [thread overview]
Message-ID: <jwvr09ldpuo.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <87ldztmaho.fsf@posteo.net> (Tomas Nordin's message of "Sun, 15 Sep 2024 11:17:55 +0000")
Tomas Nordin [2024-09-15 11:17:55] wrote:
> Stefan Kangas <stefankangas@gmail.com> writes:
>
>> Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of
>> text editors" <bug-gnu-emacs@gnu.org> writes:
>>
>>> 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'.
>>
>> Ah, now I see that you posted this proposal. This is a better start
>> than what I had.
>>
>> Should we install it?
>
> This is about the doc of remove-hook. What about the edits in the
> add-hook docstring, was that OK? There was a question on the bit about
> setting the HOOK to nil, but I think that was sorted out.
The `add-hook` part was OK for me, indeed.
[ I'm no great fan of that paragraph (neither the original nor the one
you replace it with), tho, because it's a bit "too detailed" for my
taste. E.g. the value *always* ends up being a list of functions, and
the parenthesis states something which sounds to me like it should be
inferrable from the rest of the docstring. ]
Stefan
next prev parent reply other threads:[~2024-09-15 13:19 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
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 [this message]
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=jwvr09ldpuo.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=stefankangas@gmail.com \
--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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).