GNU bug report logs - #72915
Docstrings of add-hook and remove-hook improvement?

Previous Next

Full log

Message #44 received at 72915 <at> debbugs.gnu.org (full text, mbox):

From: Tomas Nordin <tomasn <at> posteo.net>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: Eli Zaretskii <eliz <at> gnu.org>, Stefan Kangas <stefankangas <at> gmail.com>,
 72915 <at> debbugs.gnu.org
Subject: Re: bug#72915: Docstrings of add-hook and remove-hook improvement?
Date: Thu, 27 Feb 2025 21:25:32 +0000

[Message part 1 (text/plain, inline)]

Tomas Nordin <tomasn <at> posteo.net> writes:

> Stefan Monnier <monnier <at> iro.umontreal.ca> writes:
>
>> 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.  ]
>
> I think I agree, the parenthesized part could be discarded, shortening
> the paragraph to
>
> "HOOK should be a symbol.  If HOOK is void, or if HOOK's value is a
> single function, it is changed to a list of functions."

I think nothing was installed along this discussion so far. Attached is
an attempt to summarize the suggestions as patch.

[0001-Improve-docstring-of-add-hook-and-remove-hook.patch (text/x-diff, attachment)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.