From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#72915: Docstrings of add-hook and remove-hook improvement? Date: Sun, 15 Sep 2024 09:19:43 -0400 Message-ID: References: <87v7zgrhrt.fsf@posteo.net> <86y14c9dk3.fsf@gnu.org> <87ldztmaho.fsf@posteo.net> Reply-To: Stefan Monnier Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="4122"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: Eli Zaretskii , Stefan Kangas , 72915@debbugs.gnu.org To: Tomas Nordin Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Sep 15 15:21:09 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 1sppBc-0000tb-53 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 15 Sep 2024 15:21:08 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sppBM-0001ph-Qv; Sun, 15 Sep 2024 09:20:52 -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 1sppBL-0001os-8i for bug-gnu-emacs@gnu.org; Sun, 15 Sep 2024 09:20:51 -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 1sppBK-0006tQ-C9 for bug-gnu-emacs@gnu.org; Sun, 15 Sep 2024 09:20:51 -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=JP6kZd4UcatThoM4/NCLGPlBRy5bIWEoZA2wYJI26YM=; b=cWpuNa3kkMifGIQzJ5t6s9kN/jc4ASuAd7XPykUMisRs5qN0W2aNcLZfTmms+SMjAajPMjX/hSkcHc+J9Tydlz5cjsSVnGqDsq7ZUyAV0863GmBwW4+ZNY0FqJfR2QA0irW9tfSBYVU9pcmWKENnjLRIhYAZFFYEWWDEslkyS1oYc8/yLttxK/q37njcYViCm3MSJ0VSY/jWau3JfWmK2bTriaAuZ0aAXYylGB6sYcoc6NbBi9+Jksd3qtcs/a149rcXAQ7SWVnB9e4qwIjAbSFW8cMk/UV8+4qEeJmoLfB6d5CnP3kwFi/atNX/nIReLad3EGXIfmMFnZnNstKehA==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sppBW-00046F-5L for bug-gnu-emacs@gnu.org; Sun, 15 Sep 2024 09:21:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 15 Sep 2024 13:21: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.172640640615106 (code B ref 72915); Sun, 15 Sep 2024 13:21:02 +0000 Original-Received: (at 72915) by debbugs.gnu.org; 15 Sep 2024 13:20:06 +0000 Original-Received: from localhost ([127.0.0.1]:48643 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sppAc-0003va-0Q for submit@debbugs.gnu.org; Sun, 15 Sep 2024 09:20:06 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:46210) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sppAa-0003ue-L3 for 72915@debbugs.gnu.org; Sun, 15 Sep 2024 09:20:05 -0400 Original-Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id F21D0801BA; Sun, 15 Sep 2024 09:19:46 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1726406385; bh=9If+zivbYeV7m7lo2Scljp4f22mq/4P7s7hFQyU/NXg=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=JsgIYMl/vrEVXGkjqhYL7S2M/+4bpW1JboT5upXLqCRpmfpt0RqTd25P/nGab6lNa 5gbmXJricIvDx31aZj366HXci6R0QzeBMi5IHXQutTp8jVF1APr8OEM7qi84g/BYMq YyKiQrRQ7B6nDrM2248tSDacw/ihwguVGNTOhBcGpyHT/iUIyx+QFod3lErh21oeer kbWexIrIVPcf1GbmKOmFL4di/z0QhZTcwnmjq157Ln9MF0q2h6QbMpSb2NhHsF4fEN yw1ONHVyOgoX8BnmYsDfHnDGT7n7Tvmmze/5vWPJGzglXlL/ygpwqjIQIPHNxj7RPI QSTySRLU0hSxg== Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 8653D80357; Sun, 15 Sep 2024 09:19:45 -0400 (EDT) Original-Received: from pastel (104-195-209-174.cpe.teksavvy.com [104.195.209.174]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 4FD4812068E; Sun, 15 Sep 2024 09:19:45 -0400 (EDT) In-Reply-To: <87ldztmaho.fsf@posteo.net> (Tomas Nordin's message of "Sun, 15 Sep 2024 11:17:55 +0000") 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:291854 Archived-At: Tomas Nordin [2024-09-15 11:17:55] wrote: > Stefan Kangas writes: > >> Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of >> text editors" 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