From unknown Tue Aug 19 02:57:36 2025 X-Loop: help-debbugs@gnu.org Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 04 Nov 2023 12:54:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 66928 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: 66928@debbugs.gnu.org, monnier@iro.umontreal.ca X-Debbugs-Original-To: bug-gnu-emacs@gnu.org, Stefan Monnier Received: via spool by submit@debbugs.gnu.org id=B.16991023984318 (code B ref -1); Sat, 04 Nov 2023 12:54:02 +0000 Received: (at submit) by debbugs.gnu.org; 4 Nov 2023 12:53:18 +0000 Received: from localhost ([127.0.0.1]:33162 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzG9O-00017Z-AD for submit@debbugs.gnu.org; Sat, 04 Nov 2023 08:53:18 -0400 Received: from lists.gnu.org ([2001:470:142::17]:45414) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzG9M-00017M-4c for submit@debbugs.gnu.org; Sat, 04 Nov 2023 08:53:16 -0400 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 1qzG8g-0003ur-BH for bug-gnu-emacs@gnu.org; Sat, 04 Nov 2023 08:52:34 -0400 Received: from out-180.mta0.migadu.com ([2001:41d0:1004:224b::b4]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qzG8e-0004YC-5d for bug-gnu-emacs@gnu.org; Sat, 04 Nov 2023 08:52:34 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1699102349; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type; bh=sr2cc/VV2D1PV3T3nxppi72doZ8+ibdqnd42HlApviQ=; b=Y3In/p6GriUaj3RGIcpXFN5tOhmuznHxP1hDX9rROz6IGtuanyUDnGUxZZQPHLc0BT1u9i hF7kLPI6gALKXDojhCGs/NXwb4438lb4fU8NSTxiRxW63tQne3XScnthm/MbM9Y5g+2VoX C8jOECaCJl/wfMtdMj6H3MTvJec3plQaif0IIM68oUIJzTP/dOEi7lEsM6wq6MKgWMJ5Mu lLFlDu2RztI0ZKbTE6keGGCUkfqPhOUSVE6CkQSUwHP1gJKMMMYRGpZj0seroZxah+hQha 0EGf7oqg+9aSmK8/Mcia514PFO4qJCtHUhekcW8nsuQVRT32Ytw1/zEHxc4W+w== From: Jeremy Bryant Date: Sat, 04 Nov 2023 12:49:27 +0000 Message-ID: <87cywpwuid.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=2001:41d0:1004:224b::b4; envelope-from=jb@jeremybryant.net; helo=out-180.mta0.migadu.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 0.9 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.1 (/) --=-=-= Content-Type: text/plain Tags: patch Hello I noticed that for the function below the docstring doesn't match the arg names. I've chosen to keep the docstring on the basis that it may be what has been the most visible for a time, and update the names in the code. In general, is it TRT? Do we have a convention to keep names or the docstring. Please let me know if this patch is useful in its current form or a change is needed. thanks Jeremy --=-=-= Content-Type: text/patch Content-Disposition: attachment; filename=0002-Update-names-to-match-the-docstring.patch >From 927b8ef441c1367ba1fcf08172f3eb6b739eddab Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Sat, 4 Nov 2023 12:38:29 +0000 Subject: [PATCH 2/2] Update names to match the docstring * lisp/emacs-lisp/cl-extra.el (cl-remprop): Change sym to symbol, tag to propname --- lisp/emacs-lisp/cl-extra.el | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lisp/emacs-lisp/cl-extra.el b/lisp/emacs-lisp/cl-extra.el index 15be51bd651..909a1aacc47 100644 --- a/lisp/emacs-lisp/cl-extra.el +++ b/lisp/emacs-lisp/cl-extra.el @@ -635,13 +635,13 @@ cl--do-remf (and (cdr p) (progn (setcdr p (cdr (cdr (cdr p)))) t)))) ;;;###autoload -(defun cl-remprop (sym tag) +(defun cl-remprop (symbol propname) "Remove from SYMBOL's plist the property PROPNAME and its value. \n(fn SYMBOL PROPNAME)" - (let ((plist (symbol-plist sym))) - (if (and plist (eq tag (car plist))) - (progn (setplist sym (cdr (cdr plist))) t) - (cl--do-remf plist tag)))) + (let ((plist (symbol-plist symbol))) + (if (and plist (eq propname (car plist))) + (progn (setplist symbol (cdr (cdr plist))) t) + (cl--do-remf plist propname)))) ;;; Streams. -- 2.40.1 --=-=-=-- From unknown Tue Aug 19 02:57:36 2025 X-Loop: help-debbugs@gnu.org Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 04 Nov 2023 13:02:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66928 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Jeremy Bryant Cc: 66928@debbugs.gnu.org, monnier@iro.umontreal.ca Received: via spool by 66928-submit@debbugs.gnu.org id=B66928.16991028735278 (code B ref 66928); Sat, 04 Nov 2023 13:02:01 +0000 Received: (at 66928) by debbugs.gnu.org; 4 Nov 2023 13:01:13 +0000 Received: from localhost ([127.0.0.1]:33207 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzGH2-0001N4-NG for submit@debbugs.gnu.org; Sat, 04 Nov 2023 09:01:12 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:41700) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzGH1-0001Mo-B7 for 66928@debbugs.gnu.org; Sat, 04 Nov 2023 09:01:11 -0400 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qzGGL-0005v9-SQ; Sat, 04 Nov 2023 09:00:29 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=0pQhH6MGqdAzKLVTBjIY7HbbKQYh5vdBVrD8bs9IY0g=; b=lG8IEiE03kpZ 27zSWTtr5ZHDW/FmtXcusqjJ2Z9xeN+BwCVxEzMnem9WewnLZEkuifML2JhF/S/ll1eS+zsgR/Y0m 65WEVLvAXnJY4D/znm11CP1kGIsa/IwiLjuOlzK3FBDS+yf3tZEsOODcxbuM9uxOicuMfxZee8qh/ 8iDT8anc4dFAtTpbpLTcg++6amFuGLnYAPp8XyEqGx4V4R/dXNmdhWcNQJWA5hY0BsuB/jxamWGAU vAs7Ee+Sev6HAR2aN7j902LOEDeVwTw2pTPWG6euOkbyPurN2tTmnqQ0NigXu01/2JrbIaQESSsai W1qJ/E1kn6bDFh9Z/jtbHg==; Date: Sat, 04 Nov 2023 15:00:23 +0200 Message-Id: <83r0l54qs8.fsf@gnu.org> From: Eli Zaretskii In-Reply-To: <87cywpwuid.fsf@jeremybryant.net> (bug-gnu-emacs@gnu.org) References: <87cywpwuid.fsf@jeremybryant.net> X-Spam-Score: -2.3 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > Date: Sat, 04 Nov 2023 12:49:27 +0000 > From: Jeremy Bryant via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > I noticed that for the function below the docstring doesn't match the > arg names. That's why we have the "(fn SYMBOL PROPNAME)" part there. From unknown Tue Aug 19 02:57:36 2025 X-Loop: help-debbugs@gnu.org Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 04 Nov 2023 16:14:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66928 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Jeremy Bryant Cc: 66928@debbugs.gnu.org Received: via spool by 66928-submit@debbugs.gnu.org id=B66928.169911443727766 (code B ref 66928); Sat, 04 Nov 2023 16:14:02 +0000 Received: (at 66928) by debbugs.gnu.org; 4 Nov 2023 16:13:57 +0000 Received: from localhost ([127.0.0.1]:35663 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzJHZ-0007Dm-3v for submit@debbugs.gnu.org; Sat, 04 Nov 2023 12:13:57 -0400 Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:10150) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzJHW-0007DV-9o for 66928@debbugs.gnu.org; Sat, 04 Nov 2023 12:13:55 -0400 Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id 271A1440F8C; Sat, 4 Nov 2023 12:13:12 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1699114387; bh=C0/kms0tY1049UdxTpfN+d8O5kkKaIKC0sD/UgL3Iwo=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=bwWC/9nOFEgyqbWBWH2qRLvK1O2XAXK9vo99FK8Q9zxd/Ner9ytfyleoU3FK/2CTS I/gj8FEhsPB38SFehTcfkZ+orFkH6176LXOjurIvrdrwAHHJfUyz/QuUpJcjNTnxn/ PvSMGhznCoAVNoMeAzPrt/CEnbWSOt9UYXl2SJdYbJyyOrTJFn2JwW2OM/eozLJ3Mx 3W8vx0VcSs/tspb0TTzjrjrIJYbkYeG22ANTpxjL1QI+39j4RJBjUwO79E+FF4/UFv FDJjThrDwwrYzlsFSXyOpHTBXFrLvFZdkf3A3/XmR1yRYG6CR+zoyJAl6bJHTj4Jtb D8AeOImAXk+ig== Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id F0BA0440FC2; Sat, 4 Nov 2023 12:13:06 -0400 (EDT) Received: from pastel (unknown [45.72.195.71]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id CB4201201B6; Sat, 4 Nov 2023 12:13:06 -0400 (EDT) From: Stefan Monnier In-Reply-To: <87cywpwuid.fsf@jeremybryant.net> (Jeremy Bryant's message of "Sat, 04 Nov 2023 12:49:27 +0000") Message-ID: References: <87cywpwuid.fsf@jeremybryant.net> Date: Sat, 04 Nov 2023 12:13:05 -0400 User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-SPAM-INFO: Spam detection results: 0 ALL_TRUSTED -1 Passed through trusted hosts only via SMTP AWL 0.012 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DKIM_SIGNED 0.1 Message has a DKIM or DK signature, not necessarily valid DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's domain DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from domain T_SCC_BODY_TEXT_LINE -0.01 - X-SPAM-LEVEL: X-Spam-Score: -2.3 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > I noticed that for the function below the docstring doesn't match the > arg names. I agree it's an odd choice (requiring the use of `\n(fn SYMBOL PROPNAME)`), but it's not a big problem since the (fn SYMBOL PROPNAME) makes sure that the right names are presented in `C-h o`. If you want to install a patch like you suggest, then please remove the (fn SYMBOL PROPNAME) since it makes it redundant. It'd be considered as a cosmetic patch. One more thing: the first line of the commit should be a bit more specific, e.g. it could start with "(cl-remprop):" Stefan From unknown Tue Aug 19 02:57:36 2025 X-Loop: help-debbugs@gnu.org Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 04 Nov 2023 22:59:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66928 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Stefan Monnier Cc: 66928@debbugs.gnu.org Received: via spool by 66928-submit@debbugs.gnu.org id=B66928.16991386925988 (code B ref 66928); Sat, 04 Nov 2023 22:59:02 +0000 Received: (at 66928) by debbugs.gnu.org; 4 Nov 2023 22:58:12 +0000 Received: from localhost ([127.0.0.1]:35887 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzPal-0001YW-Sx for submit@debbugs.gnu.org; Sat, 04 Nov 2023 18:58:12 -0400 Received: from out-188.mta1.migadu.com ([2001:41d0:203:375::bc]:32421) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzPaj-0001YM-9O for 66928@debbugs.gnu.org; Sat, 04 Nov 2023 18:58:10 -0400 References: <87cywpwuid.fsf@jeremybryant.net> DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1699138651; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=pWGwqOHgpxRumDn5IX/FUd4tUxRf1N+k+fqMYn88aso=; b=CU/R8kyCiOTp7761K707rRnpSA4Wp5PVzPX2x3G5vawBIQnOHVLb1EafCWLjhnYzr400a9 7y6VsJRvZz8dqwnV6SXSXOWKXzIK088XKQ0x+j1Ejan+p1lxJ1bUhCvRuT7EBrci2c/4v1 nY0m2uF2DXUSipwH6iyed3n3cHuRhWyfjV4rKZJ847y83khwlwZsUPA74SsyeyCsNiqLRv aX7ZzNbeSkFNENwSGAHlmNJZ6C6QnmivhgG+5rnLxwWzUs2ZdIP5V/JtoFtS0/UEN9iz5f CULQMkC7cKXc6D0gHmRj2ceL5B3fXiebbZNHq2GZ+4lJOnIkgyH6yKie1HpitQ== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Jeremy Bryant Date: Sat, 04 Nov 2023 22:56:14 +0000 In-reply-to: Message-ID: <878r7dw2i0.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: text/plain X-Migadu-Flow: FLOW_OUT X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) thank you, I will work on this. One question, the elisp manual mentions that the \(fn ARGLIST) facility is particularly useful for macros. Why would we use this for defuns? What is TRT in general? Stefan Monnier writes: >> I noticed that for the function below the docstring doesn't match the >> arg names. > > I agree it's an odd choice (requiring the use of `\n(fn SYMBOL PROPNAME)`), > but it's not a big problem since the (fn SYMBOL PROPNAME) makes sure > that the right names are presented in `C-h o`. > > If you want to install a patch like you suggest, then please remove the > (fn SYMBOL PROPNAME) since it makes it redundant. > It'd be considered as a cosmetic patch. > > One more thing: the first line of the commit should be a bit more > specific, e.g. it could start with "(cl-remprop):" > > > Stefan From unknown Tue Aug 19 02:57:36 2025 X-Loop: help-debbugs@gnu.org Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 04 Nov 2023 23:36:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66928 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Stefan Monnier Cc: 66928@debbugs.gnu.org Received: via spool by 66928-submit@debbugs.gnu.org id=B66928.16991409509878 (code B ref 66928); Sat, 04 Nov 2023 23:36:02 +0000 Received: (at 66928) by debbugs.gnu.org; 4 Nov 2023 23:35:50 +0000 Received: from localhost ([127.0.0.1]:35905 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzQBC-0002ZG-5o for submit@debbugs.gnu.org; Sat, 04 Nov 2023 19:35:50 -0400 Received: from out-171.mta1.migadu.com ([95.215.58.171]:61140) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzQB8-0002Z3-R6 for 66928@debbugs.gnu.org; Sat, 04 Nov 2023 19:35:49 -0400 References: <87cywpwuid.fsf@jeremybryant.net> DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1699140909; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=TYfyvi4fy7sONpPfMuYubuNaMjVH8I/nlDwlkExS844=; b=Iu6FjW9ge+QkU8Nf6ElQuWo8ZNLNM3PRRlNi8F3ABP0IAIDY+3kkeSohdtBr1e41upsF+I B9u5apdI9rLfKG25y75aGRlnmtrNx3TKo28yRGbHX9/Q5KmO9Hs5PgfBTSKGt5W1iUVDdQ /Z6DYGPr7cfq0c3jy4c7oGeeoQOVqDmAbyqCZhcBQVYmc1IJXADldCtxp3qlq7xEFWvYYC CKFx67qJ2JueGSszVV4UwL0YXFxLRfq4JX7B877q0p4Nj3LT1WfRdx5Uwy2PTimqxhcidr e7u3uRNy4vRdTQQ94wHQHiivn0mJvdk/mmfnTXENyD2IuNAeyRcCCOE+djWsWA== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Jeremy Bryant Date: Sat, 04 Nov 2023 23:34:00 +0000 In-reply-to: Message-ID: <874ji1w0r9.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) --=-=-= Content-Type: text/plain Attached is a proposed patch to install, with the two changes requested. This is cosmetic patch. --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0002-lisp-emacs-lisp-cl-extra.el-cl-remprop-Update-names-.patch >From 4036426119ca939070f5353671eff9f22ed66598 Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Sat, 4 Nov 2023 23:29:10 +0000 Subject: [PATCH 2/2] * lisp/emacs-lisp/cl-extra.el (cl-remprop): Update names to match docstring --- lisp/emacs-lisp/cl-extra.el | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/lisp/emacs-lisp/cl-extra.el b/lisp/emacs-lisp/cl-extra.el index de5eb9c2d92..e41bf1cdb0b 100644 --- a/lisp/emacs-lisp/cl-extra.el +++ b/lisp/emacs-lisp/cl-extra.el @@ -633,13 +633,12 @@ cl--do-remf (and (cdr p) (progn (setcdr p (cdr (cdr (cdr p)))) t)))) ;;;###autoload -(defun cl-remprop (sym tag) - "Remove from SYMBOL's plist the property PROPNAME and its value. -\n(fn SYMBOL PROPNAME)" - (let ((plist (symbol-plist sym))) - (if (and plist (eq tag (car plist))) - (progn (setplist sym (cdr (cdr plist))) t) - (cl--do-remf plist tag)))) +(defun cl-remprop (symbol propname) + "Remove from SYMBOL's plist the property PROPNAME and its value." + (let ((plist (symbol-plist symbol))) + (if (and plist (eq propname (car plist))) + (progn (setplist symbol (cdr (cdr plist))) t) + (cl--do-remf plist propname)))) ;;; Streams. -- 2.40.1 --=-=-= Content-Type: text/plain Stefan Monnier writes: >> I noticed that for the function below the docstring doesn't match the >> arg names. > > I agree it's an odd choice (requiring the use of `\n(fn SYMBOL PROPNAME)`), > but it's not a big problem since the (fn SYMBOL PROPNAME) makes sure > that the right names are presented in `C-h o`. > > If you want to install a patch like you suggest, then please remove the > (fn SYMBOL PROPNAME) since it makes it redundant. > It'd be considered as a cosmetic patch. > > One more thing: the first line of the commit should be a bit more > specific, e.g. it could start with "(cl-remprop):" > > > Stefan --=-=-=-- From unknown Tue Aug 19 02:57:36 2025 X-Loop: help-debbugs@gnu.org Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 05 Nov 2023 14:11:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66928 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Jeremy Bryant Cc: 66928@debbugs.gnu.org Received: via spool by 66928-submit@debbugs.gnu.org id=B66928.16991934445834 (code B ref 66928); Sun, 05 Nov 2023 14:11:02 +0000 Received: (at 66928) by debbugs.gnu.org; 5 Nov 2023 14:10:44 +0000 Received: from localhost ([127.0.0.1]:36356 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzdps-0001W1-8b for submit@debbugs.gnu.org; Sun, 05 Nov 2023 09:10:44 -0500 Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:21481) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzdpq-0001Vj-Fb for 66928@debbugs.gnu.org; Sun, 05 Nov 2023 09:10:43 -0500 Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id CE0D8441AA7; Sun, 5 Nov 2023 09:09:59 -0500 (EST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1699193399; bh=CtThLhNbMUAhkm0+Mo+19G/dlaVP5FXzuSlYTI7nAdE=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=hGY+xZewuoSnG8Nh7HlM8OzcAvwbmk/Xboii8GsFsu4iLYVPw78UZTqQF6rlUulF4 fUgjQZOkMnGK/pd5XzaNGTHSEOHckNJxQGqyydA9kBRbbk1Ldcqs8Jqs7q44NHbVbd nVJImkMsbtcXtBkYcniH6eBzbIYAlROjqJ+PTk0C3E2p8vqKdEPAnPbAVnvgxe8S8v /cIDUtfqf2++LzBFTTRfjaGU1JU1J51+qtDaQqpxrpGUmaq3Ls+ZrylLeDLTXsUphg QgiBWgP0GIpMiPdPzL3BDuyA13Sb6R6heRUNA6+x9055Udxhc7rfLiJEIJNYABlIA9 UV2l2fmO9IRYw== Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id EBD334419AE; Sun, 5 Nov 2023 09:09:58 -0500 (EST) Received: from pastel (unknown [45.72.195.71]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id AC35B1203A2; Sun, 5 Nov 2023 09:09:58 -0500 (EST) From: Stefan Monnier In-Reply-To: <878r7dw2i0.fsf@jeremybryant.net> (Jeremy Bryant's message of "Sat, 04 Nov 2023 22:56:14 +0000") Message-ID: References: <87cywpwuid.fsf@jeremybryant.net> <878r7dw2i0.fsf@jeremybryant.net> Date: Sun, 05 Nov 2023 09:09:57 -0500 User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-SPAM-INFO: Spam detection results: 0 ALL_TRUSTED -1 Passed through trusted hosts only via SMTP AWL 0.012 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DKIM_SIGNED 0.1 Message has a DKIM or DK signature, not necessarily valid DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's domain DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from domain T_SCC_BODY_TEXT_LINE -0.01 - X-SPAM-LEVEL: X-Spam-Score: -2.3 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > One question, the elisp manual mentions that the \(fn ARGLIST) facility > is particularly useful for macros. > > Why would we use this for defuns? We use it for some defuns where ELisp's arglist functionality is not refined enough to express the intention of the programmer. For example, the "real" arglist may be name args &optional docstring &rest body but the intended arglist is name args [docstring] &rest body i.e. if `docstring` is not a string it's taken as the first instruction of `body`. Stefan From unknown Tue Aug 19 02:57:36 2025 X-Loop: help-debbugs@gnu.org Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Resent-From: Jeremy Bryant Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 06 Nov 2023 23:00:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66928 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Stefan Monnier Cc: 66928@debbugs.gnu.org Received: via spool by 66928-submit@debbugs.gnu.org id=B66928.16993115642482 (code B ref 66928); Mon, 06 Nov 2023 23:00:02 +0000 Received: (at 66928) by debbugs.gnu.org; 6 Nov 2023 22:59:24 +0000 Received: from localhost ([127.0.0.1]:40995 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r08Z1-0000dy-KI for submit@debbugs.gnu.org; Mon, 06 Nov 2023 17:59:23 -0500 Received: from out-178.mta1.migadu.com ([2001:41d0:203:375::b2]:19378) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r08Yy-0000dk-L8 for 66928@debbugs.gnu.org; Mon, 06 Nov 2023 17:59:22 -0500 References: <87cywpwuid.fsf@jeremybryant.net> <878r7dw2i0.fsf@jeremybryant.net> DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1699311519; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=fiN2tCnOB/ZKkUfkE67wMwdUt2/McsgoQdQ4dyGRyNU=; b=jbl6cSiBULBoey15WEhUxXoRoFEQn2Elq7jYQ1DViozHE1K2SZBJlO4nH0/HeNPhq7O3vM uj3XIKci7nk8bvJmfwmqBNRhCwK6zhsaoLiHDJgp1R+u06uLZz0ovzYEGg3cojAiRATpge adBex9xbX9T+n8iJ2I7HxtckNupfg4TBbh01aZo53dL7iFPzdxFtcgr4HsXeYzSFxce29A trXHYK6rTRAMS/vC+ro605J4HV0UDapcwihMK3plH1Ij5QuTCSR1OQfYqyGrV9FjB8J+Yo XbTGd7nkiTHPFhdpR5c5MT2w8ZFbGOkDgHqKrB+m1crIYCTwIYkswdWGH/3xBw== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Jeremy Bryant Date: Mon, 06 Nov 2023 22:55:39 +0000 In-reply-to: Message-ID: <87msvqv68y.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: text/plain X-Migadu-Flow: FLOW_OUT X-Spam-Score: 0.0 (/) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Interesting, thank you Perhaps it would be of interest to add some text to the elisp manual in (elisp) Function Documentation Are there any conventions for manual additions? in particular to keep the number of printed pages limited is there a way to say 'don't print this node'? thanks Jeremy Stefan Monnier writes: >> One question, the elisp manual mentions that the \(fn ARGLIST) facility >> is particularly useful for macros. >> >> Why would we use this for defuns? > > We use it for some defuns where ELisp's arglist functionality is not > refined enough to express the intention of the programmer. > For example, the "real" arglist may be > > name args &optional docstring &rest body > > but the intended arglist is > > name args [docstring] &rest body > > i.e. if `docstring` is not a string it's taken as the first instruction > of `body`. > > > Stefan From unknown Tue Aug 19 02:57:36 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.505 (Entity 5.505) X-Loop: help-debbugs@gnu.org From: help-debbugs@gnu.org (GNU bug Tracking System) To: Jeremy Bryant Subject: bug#66928: closed (Re: bug#66928: [PATCH 2/2] Update names to match the docstring) Message-ID: References: <87cywpwuid.fsf@jeremybryant.net> X-Gnu-PR-Message: they-closed 66928 X-Gnu-PR-Package: emacs X-Gnu-PR-Keywords: patch Reply-To: 66928@debbugs.gnu.org Date: Sun, 12 Nov 2023 20:56:02 +0000 Content-Type: multipart/mixed; boundary="----------=_1699822562-5199-1" This is a multi-part message in MIME format... ------------=_1699822562-5199-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" Your bug report #66928: [PATCH 2/2] Update names to match the docstring which was filed against the emacs package, has been closed. The explanation is attached below, along with your original report. If you require more details, please reply to 66928@debbugs.gnu.org. --=20 66928: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D66928 GNU Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1699822562-5199-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at 66928-done) by debbugs.gnu.org; 12 Nov 2023 20:55:22 +0000 Received: from localhost ([127.0.0.1]:57134 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2HUH-0001Kt-OO for submit@debbugs.gnu.org; Sun, 12 Nov 2023 15:55:21 -0500 Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:35744) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2HUE-0001KZ-KQ for 66928-done@debbugs.gnu.org; Sun, 12 Nov 2023 15:55:19 -0500 Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 778DF803B1; Sun, 12 Nov 2023 15:54:31 -0500 (EST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1699822470; bh=E2zYKRJ+7sFF3Ox7unoM3QyAsWQES2pxycdmeClMIvY=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=n5pwatWRI7S+1DzY2hIMvfdLny+jVwhFQAMDKRF9O1Ec3gD9c8I5Fv4aWfcWYNYzo NovAQz20+1eElBHF/RczfzlQ81xyk6MQ7T1fM2rRK4C82QoB2gd5OSBD+McPPO9XyC HMxrL4fa9I/vvjPx0f+a6gSuY6/rm+HYDt0sYs8AfpifKsGf984OskXQP485Z0/sDt tB1xSx/gmXc90ZYqyWW/zzB3p9l2cALLVfkm//P7xZHVWR7OoAJ5n5TSAwQMV5Jt8D 7+Xd/N+1H5Gce835gSHdqcB41Iz0b0JNpqC3peJzgusVxrjtWnRC9SFqfJLbtCMquw dk0wIuo3w6oTw== Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id AE7AC801D4; Sun, 12 Nov 2023 15:54:30 -0500 (EST) Received: from pastel (unknown [45.72.227.120]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 83E7012034F; Sun, 12 Nov 2023 15:54:30 -0500 (EST) From: Stefan Monnier To: Jeremy Bryant Subject: Re: bug#66928: [PATCH 2/2] Update names to match the docstring In-Reply-To: <87cywpwuid.fsf@jeremybryant.net> (Jeremy Bryant's message of "Sat, 04 Nov 2023 12:49:27 +0000") Message-ID: References: <87cywpwuid.fsf@jeremybryant.net> Date: Sun, 12 Nov 2023 15:54:24 -0500 User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-SPAM-INFO: Spam detection results: 0 ALL_TRUSTED -1 Passed through trusted hosts only via SMTP AWL 0.016 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DKIM_SIGNED 0.1 Message has a DKIM or DK signature, not necessarily valid DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's domain DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from domain T_SCC_BODY_TEXT_LINE -0.01 - X-SPAM-LEVEL: X-Spam-Score: -2.3 (--) X-Debbugs-Envelope-To: 66928-done Cc: 66928-done@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > I noticed that for the function below the docstring doesn't match the > arg names. I've chosen to keep the docstring on the basis that it may This is now fixed, closing, Stefan ------------=_1699822562-5199-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit Received: (at submit) by debbugs.gnu.org; 4 Nov 2023 12:53:18 +0000 Received: from localhost ([127.0.0.1]:33162 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzG9O-00017Z-AD for submit@debbugs.gnu.org; Sat, 04 Nov 2023 08:53:18 -0400 Received: from lists.gnu.org ([2001:470:142::17]:45414) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzG9M-00017M-4c for submit@debbugs.gnu.org; Sat, 04 Nov 2023 08:53:16 -0400 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 1qzG8g-0003ur-BH for bug-gnu-emacs@gnu.org; Sat, 04 Nov 2023 08:52:34 -0400 Received: from out-180.mta0.migadu.com ([2001:41d0:1004:224b::b4]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qzG8e-0004YC-5d for bug-gnu-emacs@gnu.org; Sat, 04 Nov 2023 08:52:34 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1699102349; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type; bh=sr2cc/VV2D1PV3T3nxppi72doZ8+ibdqnd42HlApviQ=; b=Y3In/p6GriUaj3RGIcpXFN5tOhmuznHxP1hDX9rROz6IGtuanyUDnGUxZZQPHLc0BT1u9i hF7kLPI6gALKXDojhCGs/NXwb4438lb4fU8NSTxiRxW63tQne3XScnthm/MbM9Y5g+2VoX C8jOECaCJl/wfMtdMj6H3MTvJec3plQaif0IIM68oUIJzTP/dOEi7lEsM6wq6MKgWMJ5Mu lLFlDu2RztI0ZKbTE6keGGCUkfqPhOUSVE6CkQSUwHP1gJKMMMYRGpZj0seroZxah+hQha 0EGf7oqg+9aSmK8/Mcia514PFO4qJCtHUhekcW8nsuQVRT32Ytw1/zEHxc4W+w== From: Jeremy Bryant To: bug-gnu-emacs@gnu.org, Stefan Monnier Subject: [PATCH 2/2] Update names to match the docstring Date: Sat, 04 Nov 2023 12:49:27 +0000 Message-ID: <87cywpwuid.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=2001:41d0:1004:224b::b4; envelope-from=jb@jeremybryant.net; helo=out-180.mta0.migadu.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-Spam-Score: 0.9 (/) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -0.1 (/) --=-=-= Content-Type: text/plain Tags: patch Hello I noticed that for the function below the docstring doesn't match the arg names. I've chosen to keep the docstring on the basis that it may be what has been the most visible for a time, and update the names in the code. In general, is it TRT? Do we have a convention to keep names or the docstring. Please let me know if this patch is useful in its current form or a change is needed. thanks Jeremy --=-=-= Content-Type: text/patch Content-Disposition: attachment; filename=0002-Update-names-to-match-the-docstring.patch >From 927b8ef441c1367ba1fcf08172f3eb6b739eddab Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Sat, 4 Nov 2023 12:38:29 +0000 Subject: [PATCH 2/2] Update names to match the docstring * lisp/emacs-lisp/cl-extra.el (cl-remprop): Change sym to symbol, tag to propname --- lisp/emacs-lisp/cl-extra.el | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/lisp/emacs-lisp/cl-extra.el b/lisp/emacs-lisp/cl-extra.el index 15be51bd651..909a1aacc47 100644 --- a/lisp/emacs-lisp/cl-extra.el +++ b/lisp/emacs-lisp/cl-extra.el @@ -635,13 +635,13 @@ cl--do-remf (and (cdr p) (progn (setcdr p (cdr (cdr (cdr p)))) t)))) ;;;###autoload -(defun cl-remprop (sym tag) +(defun cl-remprop (symbol propname) "Remove from SYMBOL's plist the property PROPNAME and its value. \n(fn SYMBOL PROPNAME)" - (let ((plist (symbol-plist sym))) - (if (and plist (eq tag (car plist))) - (progn (setplist sym (cdr (cdr plist))) t) - (cl--do-remf plist tag)))) + (let ((plist (symbol-plist symbol))) + (if (and plist (eq propname (car plist))) + (progn (setplist symbol (cdr (cdr plist))) t) + (cl--do-remf plist propname)))) ;;; Streams. -- 2.40.1 --=-=-=-- ------------=_1699822562-5199-1-- From unknown Tue Aug 19 02:57:36 2025 X-Loop: help-debbugs@gnu.org Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 12 Nov 2023 21:03:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66928 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Jeremy Bryant Cc: 66928@debbugs.gnu.org Received: via spool by 66928-submit@debbugs.gnu.org id=B66928.16998229725913 (code B ref 66928); Sun, 12 Nov 2023 21:03:01 +0000 Received: (at 66928) by debbugs.gnu.org; 12 Nov 2023 21:02:52 +0000 Received: from localhost ([127.0.0.1]:57142 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2HbX-0001XI-KA for submit@debbugs.gnu.org; Sun, 12 Nov 2023 16:02:51 -0500 Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:51468) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2HbU-0001X2-L0 for 66928@debbugs.gnu.org; Sun, 12 Nov 2023 16:02:49 -0500 Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id C59864417B0; Sun, 12 Nov 2023 16:02:01 -0500 (EST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1699822920; bh=kp45YeuOjK9YUyqEX6zlkJm7k/bAuJf4kN6Tyl2rGdI=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=YMsJgZv/L5sUmydEfze5eipvee7j4ZrfktsGK2IlFu7bY8XH0r8QgWAy2V/Yo76+i Mxw4Y2DL8fbXxJduyVM1cWxDhcs750XjM4q3HpMXiFUI4Mv6H7HATGUk57yGr66ki5 vZBZkJaKgWtLwilfN7Rq/HZv75bF9XUHHcBNKarzPQfP0aVSeIL15jZ7iaBsrvXZLp zHWY4DtVR6B58Au6DiYP+vhypZOq8OW9msuw2t8O9PSOKx31nk3Y0fF3GCINUlGS5q q4obcEhpHjOu7n/6zLrVN82AuwN3+0yeH6gmX9btYrQYdVdj+5Y6zpuH2+JpitGxs3 flNaAJh4v5asQ== Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id C63B24416F9; Sun, 12 Nov 2023 16:02:00 -0500 (EST) Received: from pastel (unknown [45.72.227.120]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id A529112040A; Sun, 12 Nov 2023 16:02:00 -0500 (EST) From: Stefan Monnier In-Reply-To: <87msvqv68y.fsf@jeremybryant.net> (Jeremy Bryant's message of "Mon, 06 Nov 2023 22:55:39 +0000") Message-ID: References: <87cywpwuid.fsf@jeremybryant.net> <878r7dw2i0.fsf@jeremybryant.net> <87msvqv68y.fsf@jeremybryant.net> Date: Sun, 12 Nov 2023 16:02:00 -0500 User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-SPAM-INFO: Spam detection results: 0 ALL_TRUSTED -1 Passed through trusted hosts only via SMTP AWL 0.022 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DKIM_SIGNED 0.1 Message has a DKIM or DK signature, not necessarily valid DKIM_VALID -0.1 Message has at least one valid DKIM or DK signature DKIM_VALID_AU -0.1 Message has a valid DKIM or DK signature from author's domain DKIM_VALID_EF -0.1 Message has a valid DKIM or DK signature from envelope-from domain T_SCC_BODY_TEXT_LINE -0.01 - X-SPAM-LEVEL: X-Spam-Score: -2.3 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > Perhaps it would be of interest to add some text to the elisp manual > in (elisp) Function Documentation There's already a note about the (fn ...) convention, but if you have an idea of something that would have been helpful to, please send us your suggestion :-) > Are there any conventions for manual additions? > in particular to keep the number of printed pages limited is there a way > to say 'don't print this node'? I think there were ways to keep some parts out of the printed manual, but I'm not sure this is relevant to the ELisp manual any more: is it still printed? The FSF shop still carries the Emacs manual and the ELisp intro, but I can't see the ELisp manual in there. Stefan From unknown Tue Aug 19 02:57:36 2025 X-Loop: help-debbugs@gnu.org Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 13 Nov 2023 14:00:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66928 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch To: Stefan Monnier , Richard Stallman Cc: 66928@debbugs.gnu.org, jb@jeremybryant.net Received: via spool by 66928-submit@debbugs.gnu.org id=B66928.169988399421908 (code B ref 66928); Mon, 13 Nov 2023 14:00:02 +0000 Received: (at 66928) by debbugs.gnu.org; 13 Nov 2023 13:59:54 +0000 Received: from localhost ([127.0.0.1]:57702 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2XTm-0005hH-5k for submit@debbugs.gnu.org; Mon, 13 Nov 2023 08:59:54 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:41056) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r2XTl-0005h5-1y for 66928@debbugs.gnu.org; Mon, 13 Nov 2023 08:59:53 -0500 Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1r2XSy-0001kR-A5; Mon, 13 Nov 2023 08:59:04 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=Unqcz2rIK+BX9Owv1leCzQJNlEzLWnK6cc1vqAzSKV4=; b=kuu+KESqvZze qA7BglL3VWvSJI/XeA7zoeJqJsrRSgOqRwLx+pnuS6ptiqeHHWwBCart8+T0vUxOYqB2M+8iNCDex I19xodcVN/x1HBG0cA0PKW+0TMTF7OjfMlwbDfqI/OjJg4nh4NFDFflNDthLbtZMT2yCJsiyuxDhi yEV0UZ78gf7u+X9+bEE9UzWj6dc/rwqjfxzeJlwFXvBRGUPZGLBprARtoRbz4a7fj0DBvKSZEAr7g HCXz/OlGdo7a2QEir2KOFFM3ZbX1N9+dihCiv7NsBR8bOV38Ziu79lVmwr6z30eugqAMr66U00p62 zPGuvyyMLQy7XuITAaxvlg==; Date: Mon, 13 Nov 2023 15:58:30 +0200 Message-Id: <83ttppu54p.fsf@gnu.org> From: Eli Zaretskii In-Reply-To: (bug-gnu-emacs@gnu.org) References: <87cywpwuid.fsf@jeremybryant.net> <878r7dw2i0.fsf@jeremybryant.net> <87msvqv68y.fsf@jeremybryant.net> X-Spam-Score: -2.3 (--) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -3.3 (---) > Cc: 66928@debbugs.gnu.org > Date: Sun, 12 Nov 2023 16:02:00 -0500 > From: Stefan Monnier via "Bug reports for GNU Emacs, > the Swiss army knife of text editors" > > > Are there any conventions for manual additions? > > in particular to keep the number of printed pages limited is there a way > > to say 'don't print this node'? > > I think there were ways to keep some parts out of the printed manual, Yes, use @ifnottex..@end ifnottex. > but I'm not sure this is relevant to the ELisp manual any more: is it > still printed? > > The FSF shop still carries the Emacs manual and the ELisp intro, but > I can't see the ELisp manual in there. Richard?