From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Tomas Nordin Newsgroups: gmane.emacs.bugs Subject: bug#72915: Docstrings of add-hook and remove-hook improvement? Date: Sun, 15 Sep 2024 13:49:15 +0000 Message-ID: <87frq1m3hg.fsf@posteo.net> References: <87v7zgrhrt.fsf@posteo.net> <86y14c9dk3.fsf@gnu.org> <87ldztmaho.fsf@posteo.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="28322"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Eli Zaretskii , Stefan Kangas , 72915@debbugs.gnu.org To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Sep 15 15:50:15 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1sppdm-0007D3-Dm for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 15 Sep 2024 15:50:14 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sppdW-0005gu-VX; Sun, 15 Sep 2024 09:49:59 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sppdQ-0005gE-JU for bug-gnu-emacs@gnu.org; Sun, 15 Sep 2024 09:49:53 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sppdQ-0002OY-As for bug-gnu-emacs@gnu.org; Sun, 15 Sep 2024 09:49:52 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:References:In-Reply-To:From:To:Subject; bh=uFf9NYPwnEpSQ4Qa5B576rva3PngfT3oO4O9DBRy+ic=; b=R/W4gPdWbUNVfqSWCl/0DDpAlZwLYCxZfARu3sIeRD6GXSqc3QJY6zBBsJd9vYSTI4D5vMDEUiWZ2QmEKLOX+RBGuYt7BwEQqfj40cpxFRKcEXQJuzeOpBwHq/lR030B/JlXEDTLsMx3md4mWLiWWhizDseRbpFXuYssWBJfC5ZtzUcghmuDyulWsYuYE9pjvn+o+9poCnEwWCZ1+pP3jK3+WBO12Eqv331CJSfvYY0da9iXXakqBfMREQEo1GgmwNjobmbKU9CNzLae7Y/xbtwWRXzX38o8/Z+J8EcXvzSgLDlhR0/HHIMchZhC9i5qoNoNmHQtdGmLLTc8Mb6e4w==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sppda-0005h4-7x for bug-gnu-emacs@gnu.org; Sun, 15 Sep 2024 09:50:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Tomas Nordin Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 15 Sep 2024 13:50:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 72915 X-GNU-PR-Package: emacs Original-Received: via spool by 72915-submit@debbugs.gnu.org id=B72915.172640818021840 (code B ref 72915); Sun, 15 Sep 2024 13:50:02 +0000 Original-Received: (at 72915) by debbugs.gnu.org; 15 Sep 2024 13:49:40 +0000 Original-Received: from localhost ([127.0.0.1]:48705 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sppdD-0005gB-Pp for submit@debbugs.gnu.org; Sun, 15 Sep 2024 09:49:40 -0400 Original-Received: from mout01.posteo.de ([185.67.36.65]:58805) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sppdA-0005fw-8d for 72915@debbugs.gnu.org; Sun, 15 Sep 2024 09:49:37 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 76366240027 for <72915@debbugs.gnu.org>; Sun, 15 Sep 2024 15:49:18 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1726408158; bh=UXZZR71nnMSwl7vGlbwbFtcvVunTtNDntvivFw/1Tv0=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type: From; b=UGGNzWLDMPvzUCoEV1S8lTecAP3JaRkxXP/EcRAUjFgGdZ4P+K/10vQYCXT+9BjWL TkhaGpC/h+nKfwSwXhXU3WRgKbXV6fQb3Ixm/q34JrEKXzgVzWxofLM/WI6rtBTnLi xh6UxTst/krqFplUrDiMHWVSaS4zDPM3JUZuQYPnkRj+CHJNyRG5Fp6cbMKlxsvGam IYYm1i6dvg7jyHT9SlbKBQuJerTxUZMYWkah0cB5XWCUCgIdpDm0nY23fuKzMZVIGK EQJFoa8E5RSj3+OsjQ7qQUUu1AxQxWI9DbOOYTbpKUwCoqZcCPdVcz+2I3vcdgVZIU emzpaqWN4iyeQ== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4X68Xr3wzhz6txy; Sun, 15 Sep 2024 15:49:16 +0200 (CEST) In-Reply-To: X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:291855 Archived-At: Stefan Monnier 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."