From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#66928: [PATCH 2/2] Update names to match the docstring Date: Sat, 04 Nov 2023 23:34:00 +0000 Message-ID: <874ji1w0r9.fsf@jeremybryant.net> References: <87cywpwuid.fsf@jeremybryant.net> Reply-To: Jeremy Bryant Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1959"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 66928@debbugs.gnu.org To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sun Nov 05 00:35:46 2023 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 1qzQB7-0000I7-IU for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 05 Nov 2023 00:35:45 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qzQAq-0001BF-55; Sat, 04 Nov 2023 19:35:28 -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 1qzQAo-0001Ao-Re for bug-gnu-emacs@gnu.org; Sat, 04 Nov 2023 19:35:26 -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 1qzQAo-0000nY-JX for bug-gnu-emacs@gnu.org; Sat, 04 Nov 2023 19:35:26 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1qzQBO-0002Zg-BL for bug-gnu-emacs@gnu.org; Sat, 04 Nov 2023 19:36:02 -0400 X-Loop: help-debbugs@gnu.org 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 Original-Received: via spool by 66928-submit@debbugs.gnu.org id=B66928.16991409509878 (code B ref 66928); Sat, 04 Nov 2023 23:36:02 +0000 Original-Received: (at 66928) by debbugs.gnu.org; 4 Nov 2023 23:35:50 +0000 Original-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 Original-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 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. In-reply-to: X-Migadu-Flow: FLOW_OUT 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:273795 Archived-At: --=-=-= 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 --=-=-=--