From unknown Sat Aug 09 13:08:26 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#66863 <66863@debbugs.gnu.org> To: bug#66863 <66863@debbugs.gnu.org> Subject: Status: [PATCH] Add two docstrings in cl-macs.el Reply-To: bug#66863 <66863@debbugs.gnu.org> Date: Sat, 09 Aug 2025 20:08:26 +0000 retitle 66863 [PATCH] Add two docstrings in cl-macs.el reassign 66863 emacs submitter 66863 Jeremy Bryant severity 66863 normal tag 66863 patch thanks From debbugs-submit-bounces@debbugs.gnu.org Tue Oct 31 18:41:14 2023 Received: (at submit) by debbugs.gnu.org; 31 Oct 2023 22:41:14 +0000 Received: from localhost ([127.0.0.1]:49466 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qxxQ9-0006yS-Qz for submit@debbugs.gnu.org; Tue, 31 Oct 2023 18:41:14 -0400 Received: from lists.gnu.org ([2001:470:142::17]:36362) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qxxQ6-0006y9-3m for submit@debbugs.gnu.org; Tue, 31 Oct 2023 18:41:12 -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 1qxxPS-00052Z-FK for bug-gnu-emacs@gnu.org; Tue, 31 Oct 2023 18:40:30 -0400 Received: from out-189.mta0.migadu.com ([2001:41d0:1004:224b::bd]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qxxPP-00036m-RU for bug-gnu-emacs@gnu.org; Tue, 31 Oct 2023 18:40:30 -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=1698792017; 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=K1JsJqCAG2Assj7+YijOR8mXjArz27vJJl35W6I2nNU=; b=Qsw5HxXnFHsbBXcJjfPYMMuRuRMvmAvSOkZf8H1+WP5svFbxhEmIW778NyMkkwjQ1EfN54 XWXWhPN36lvU4xRglxa4s8bgMT/BbGZjH85+rooZshnWxPwzPWAysZch0mlxIVskjSD2I5 HjfKAuVNZ3pemc6tCD+7K6O8mE7pGdD/LErI5WWPtuB5J4JXhSoe5tcz0LMqapq3z4BuNq Yl0boBBbfkP2VkqGl8P+2Fq0ewklMumvbAXnOS8dq6TyAA59BfkMjiw9mk3kN1flo7Nvzm abWgYFf0TvLCSatPe6VnyNFmzOSme2gjLzjj+iyEqzz82OyX4tidxxaGNDJnSQ== From: Jeremy Bryant To: bug-gnu-emacs@gnu.org, Stefan Monnier Subject: [PATCH] Add two docstrings in cl-macs.el Date: Tue, 31 Oct 2023 22:36:57 +0000 Message-ID: <87bkcexvoy.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::bd; envelope-from=jb@jeremybryant.net; helo=out-189.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 Hi Emacs maintainers, Here is a proposed patch with two docstrings added to cl-macs.el where there were none previously. In particular, from previous changes, I assume that Stefan you may be familiar with this area? I look forward to your feedback. Best Jeremy --=-=-= Content-Type: text/patch Content-Disposition: attachment; filename=0001-Add-two-docstrings-in-cl-macs.el.patch >From 9a0d8649511377a160f410fd73f74558f4a8e9dc Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Tue, 31 Oct 2023 22:24:20 +0000 Subject: [PATCH] Add two docstrings in cl-macs.el * lisp/emacs-lisp/cl-macs.el (cl--simple-exprs-p) (cl--const-expr-p): Add docstrings. --- lisp/emacs-lisp/cl-macs.el | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el index 43207ce7026..fd19bca60d9 100644 --- a/lisp/emacs-lisp/cl-macs.el +++ b/lisp/emacs-lisp/cl-macs.el @@ -101,6 +101,7 @@ cl--simple-expr-p (and (> size 0) (1- size)))) (defun cl--simple-exprs-p (xs) + "Check if no side effects, and executes quickly, for each element of list XS." (while (and xs (cl--simple-expr-p (car xs))) (setq xs (cdr xs))) (not xs)) @@ -118,6 +119,7 @@ cl--safe-expr-p ;;; Check if constant (i.e., no side effects or dependencies). (defun cl--const-expr-p (x) + "Check if X is constant (i.e., no side effects or dependencies)." (cond ((consp x) (or (eq (car x) 'quote) (and (memq (car x) '(function cl-function)) -- 2.40.1 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Tue Oct 31 19:01:40 2023 Received: (at submit) by debbugs.gnu.org; 31 Oct 2023 23:01:40 +0000 Received: from localhost ([127.0.0.1]:49472 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qxxjv-0001nh-SX for submit@debbugs.gnu.org; Tue, 31 Oct 2023 19:01:40 -0400 Received: from lists.gnu.org ([2001:470:142::17]:45526) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qxxjq-0001nJ-IR for submit@debbugs.gnu.org; Tue, 31 Oct 2023 19:01:38 -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 1qxxj6-0002E2-Tw for bug-gnu-emacs@gnu.org; Tue, 31 Oct 2023 19:00:50 -0400 Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qxxj1-0005mv-HN for bug-gnu-emacs@gnu.org; Tue, 31 Oct 2023 19:00:48 -0400 Received: from pmg1.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg1.iro.umontreal.ca (Proxmox) with ESMTP id EDEAC1000BC; Tue, 31 Oct 2023 19:00:41 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1698793241; bh=l5YANpX8CS1yWSb0p6btPuyRwVF4m/WH59w4tqI+Fic=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=NxYpF96iICgP1dvh1PU5Leq/I/DkuCadUB0AFClVddt0CPdz0h6TlVXI7KaQYdPqf ykcPlc96O/uDTTG/2qrPcl5pN10g+NI9EwQCuDbc/psxtVzTu3wQHLhWkxyyhckyZ7 uLAPPWtUwC73PKe4pZtm7Y1srxi6tJpaXBNnf8OIoI6GuXRzA0jAKCTrwjWGQsbRTE 2cFrZiFsJ/wHgj9/SOyHCrZubpEWEVzf6328ql13k6fGS3O6GLt0M1zZ9+XT8P9qkG n4XaPy4wjS/9dSyaYi7FDZDfgpvdGnI2Q4SQojrI8B4lOH5evlRd2RDxSrdukeCltm wnVbQDZho8lKg== Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg1.iro.umontreal.ca (Proxmox) with ESMTP id 54FC1100033; Tue, 31 Oct 2023 19:00:41 -0400 (EDT) Received: from lechazo (lechon.iro.umontreal.ca [132.204.27.242]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 469E61203DA; Tue, 31 Oct 2023 19:00:41 -0400 (EDT) From: Stefan Monnier To: Jeremy Bryant Subject: Re: [PATCH] Add two docstrings in cl-macs.el In-Reply-To: <87bkcexvoy.fsf@jeremybryant.net> (Jeremy Bryant's message of "Tue, 31 Oct 2023 22:36:57 +0000") Message-ID: References: <87bkcexvoy.fsf@jeremybryant.net> Date: Tue, 31 Oct 2023 18:58:26 -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.078 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: Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, 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.0 (/) X-Debbugs-Envelope-To: submit Cc: bug-gnu-emacs@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: -1.0 (-) > * lisp/emacs-lisp/cl-macs.el (cl--simple-exprs-p) > (cl--const-expr-p): Add docstrings. Hmm... tackling some tricky ones, eh? > (defun cl--simple-exprs-p (xs) > + "Check if no side effects, and executes quickly, for each element of list XS." > (while (and xs (cl--simple-expr-p (car xs))) > (setq xs (cdr xs))) > (not xs)) I think I'd use a ref to `cl--simple-expr-p`, so we don't duplicate the poorly defined "no side effects, and executes quickly". Wait... `grep` says this function is not used any more, so maybe the better option is to delete it. > @@ -118,6 +119,7 @@ cl--safe-expr-p > > ;;; Check if constant (i.e., no side effects or dependencies). > (defun cl--const-expr-p (x) > + "Check if X is constant (i.e., no side effects or dependencies)." > (cond ((consp x) > (or (eq (car x) 'quote) > (and (memq (car x) '(function cl-function)) Yeah..hmm.. by order of increasing preference: - Move the comment to the docstring rather that just copying it. - Clarify the difference with `macroexp-const-p`. - Declare the function obsoleted by `macroexp-const-p`. - Delete the function altogether. Stefan From debbugs-submit-bounces@debbugs.gnu.org Tue Oct 31 19:43:12 2023 Received: (at submit) by debbugs.gnu.org; 31 Oct 2023 23:43:12 +0000 Received: from localhost ([127.0.0.1]:49485 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qxyO7-0002tJ-IA for submit@debbugs.gnu.org; Tue, 31 Oct 2023 19:43:11 -0400 Received: from lists.gnu.org ([2001:470:142::17]:44300) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qxyO5-0002t2-8q for submit@debbugs.gnu.org; Tue, 31 Oct 2023 19:43:10 -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 1qxyNQ-00027I-AD for bug-gnu-emacs@gnu.org; Tue, 31 Oct 2023 19:42:28 -0400 Received: from out-175.mta0.migadu.com ([2001:41d0:1004:224b::af]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qxyNM-0004UT-GG for bug-gnu-emacs@gnu.org; Tue, 31 Oct 2023 19:42:27 -0400 References: <87bkcexvoy.fsf@jeremybryant.net> DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1698795736; 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=Ml/ee1nUHTJTRyr4V0HfG/YWa2k3B9oT265PNhx779U=; b=TCabG8wrePptpx89q6hFcOxmSURVGjyASQDy6aaLsPDmRFB7pAcx1h776WEnwk3WIKqqMw bg2/+507uTVHuQoVTyt3JZH/0WZeqv8pEhgoB4HWWoKrPzUatu7TtLMXy593tMgUz887Aj 9/x+1Ma24dfeyDlwuGbIEuJkIFzKoPKMtQJ8SE0YYOKc6/bUloPcXAf4g1AgM3xDPnG5F+ CAPLqMKhwVw0MtzozkDk/7V6n9j11CL/rvo1HttQZY+3/AoVdFqfZoIrE9yyB2oVJc3ysL SoatvaUMF/5rBR2F0ZNVEIK4b+xgYyK83HKEikzj308HQL79xe5kW6kuMJ4knA== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Jeremy Bryant To: Stefan Monnier Subject: Re: [PATCH] Add two docstrings in cl-macs.el Date: Tue, 31 Oct 2023 23:40:04 +0000 In-reply-to: Message-ID: <8734xqxstn.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::af; envelope-from=jb@jeremybryant.net; helo=out-175.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 Cc: bug-gnu-emacs@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: -0.1 (/) --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Add-two-docstrings-in-cl-macs.el.patch >From 16298965905b1859aa8a342b98803f4abd6da3f0 Mon Sep 17 00:00:00 2001 From: Jeremy Bryant Date: Tue, 31 Oct 2023 23:37:10 +0000 Subject: [PATCH] Add two docstrings in cl-macs.el * lisp/emacs-lisp/cl-macs.el (cl--simple-exprs-p) (cl--const-expr-p): Add docstrings --- lisp/emacs-lisp/cl-macs.el | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el index 43207ce7026..15b56d0e322 100644 --- a/lisp/emacs-lisp/cl-macs.el +++ b/lisp/emacs-lisp/cl-macs.el @@ -101,6 +101,7 @@ cl--simple-expr-p (and (> size 0) (1- size)))) (defun cl--simple-exprs-p (xs) + "Map `cl--simple-expr-p' to each element of list XS." (while (and xs (cl--simple-expr-p (car xs))) (setq xs (cdr xs))) (not xs)) @@ -116,8 +117,10 @@ cl--safe-expr-p (while (and (setq x (cdr x)) (cl--safe-expr-p (car x)))) (null x))))) -;;; Check if constant (i.e., no side effects or dependencies). (defun cl--const-expr-p (x) + "Check if X is constant (i.e., no side effects or dependencies). + +See `macroexp-const-p' for similar functionality without cl-lib dependency." (cond ((consp x) (or (eq (car x) 'quote) (and (memq (car x) '(function cl-function)) -- 2.40.1 --=-=-= Content-Type: text/plain Hi Stefan, Revised patch attached and comments below Kind regards Jeremy Bryant Stefan Monnier writes: >> * lisp/emacs-lisp/cl-macs.el (cl--simple-exprs-p) >> (cl--const-expr-p): Add docstrings. > > Hmm... tackling some tricky ones, eh? Apparently yes! > >> (defun cl--simple-exprs-p (xs) >> + "Check if no side effects, and executes quickly, for each element of list XS." >> (while (and xs (cl--simple-expr-p (car xs))) >> (setq xs (cdr xs))) >> (not xs)) > > I think I'd use a ref to `cl--simple-expr-p`, so we don't duplicate the > poorly defined "no side effects, and executes quickly". See revised patch which follows this advice > > Wait... `grep` says this function is not used any more, so maybe the > better option is to delete it. > >> @@ -118,6 +119,7 @@ cl--safe-expr-p >> >> ;;; Check if constant (i.e., no side effects or dependencies). >> (defun cl--const-expr-p (x) >> + "Check if X is constant (i.e., no side effects or dependencies)." >> (cond ((consp x) >> (or (eq (car x) 'quote) >> (and (memq (car x) '(function cl-function)) > > Yeah..hmm.. by order of increasing preference: > - Move the comment to the docstring rather that just copying it. Done > - Clarify the difference with `macroexp-const-p`. Added reference to this with my interpretation of the difference (which could need change or not) > - Declare the function obsoleted by `macroexp-const-p`. > - Delete the function altogether. > > > Stefan --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Wed Nov 01 08:18:27 2023 Received: (at submit) by debbugs.gnu.org; 1 Nov 2023 12:18:27 +0000 Received: from localhost ([127.0.0.1]:50105 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qyAB1-00069e-41 for submit@debbugs.gnu.org; Wed, 01 Nov 2023 08:18:27 -0400 Received: from lists.gnu.org ([2001:470:142::17]:42478) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qyAAx-00069N-27 for submit@debbugs.gnu.org; Wed, 01 Nov 2023 08:18:25 -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 1qyAAI-0007m4-CO for bug-gnu-emacs@gnu.org; Wed, 01 Nov 2023 08:17:42 -0400 Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qyAAG-0000E6-Bd for bug-gnu-emacs@gnu.org; Wed, 01 Nov 2023 08:17:42 -0400 Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id C177644145F; Wed, 1 Nov 2023 08:17:38 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1698841057; bh=X8wFfqlV8MxIDVxtkpYGAfz3N00z6KPTgi/Qmm7D2LY=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=MNLPzzdNsQet8HM+65YcyODMBlZNKh9cdafmThI134pM01S6xUPT/9iJVa5z3jQ9f Qo8X4lOXZvH6ImJFP1EgYVKRFzpVh/RuaOteH+eJRZlJVXGsbbcW2jEzD1mhUnML8G xdaeYP/NITUS6uFkN+r8fltaWGR03oCMwTaubOOHPnGubimhHM5XLxaF3xvFG9crVz +CztjjQi32IXRmWxJfLpG59TDQOvHqGtVQ3WUFZ86rd7793KlgRMUlPcLrZ8iID97a HTO/OFF7OKu0lb8DuwwklPuwvYP3wUwAkyrZ7mFTn6CAcT13t6tFWSas3Cduc5Hy2I JHhbF+8wfJprQ== Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id AEC1744143A; Wed, 1 Nov 2023 08:17:37 -0400 (EDT) Received: from pastel (unknown [45.72.195.71]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 8B83D1201E3; Wed, 1 Nov 2023 08:17:37 -0400 (EDT) From: Stefan Monnier To: Jeremy Bryant Subject: Re: [PATCH] Add two docstrings in cl-macs.el In-Reply-To: <8734xqxstn.fsf@jeremybryant.net> (Jeremy Bryant's message of "Tue, 31 Oct 2023 23:40:04 +0000") Message-ID: References: <87bkcexvoy.fsf@jeremybryant.net> <8734xqxstn.fsf@jeremybryant.net> Date: Wed, 01 Nov 2023 08:17:36 -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.009 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: Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, 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.0 (/) X-Debbugs-Envelope-To: submit Cc: bug-gnu-emacs@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: -1.0 (-) > From 16298965905b1859aa8a342b98803f4abd6da3f0 Mon Sep 17 00:00:00 2001 > From: Jeremy Bryant > Date: Tue, 31 Oct 2023 23:37:10 +0000 > Subject: [PATCH] Add two docstrings in cl-macs.el Thanks, pushed. > (defun cl--simple-exprs-p (xs) > + "Map `cl--simple-expr-p' to each element of list XS." This doesn't say how the results of `cl--simple-expr-p` are combined, it might even suggest they're returned as a list. I think I would have said something like "Like `cl--simple-expr-p' but for a list of expressions." > (defun cl--const-expr-p (x) > + "Check if X is constant (i.e., no side effects or dependencies). > + > +See `macroexp-const-p' for similar functionality without cl-lib dependency." "Similar" fails to describe the difference :-( [ Note, I can't blame you: I know the difference but I couldn't come up with a useful description of it, that is, one that is easier to understand than the code itself. FWIW I believe the difference is a latent bug, which is partly why I'd like to delete the function :-) ] Stefan From debbugs-submit-bounces@debbugs.gnu.org Sat Nov 04 05:25:19 2023 Received: (at submit) by debbugs.gnu.org; 4 Nov 2023 09:25:19 +0000 Received: from localhost ([127.0.0.1]:60954 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzCu7-0000ot-C9 for submit@debbugs.gnu.org; Sat, 04 Nov 2023 05:25:19 -0400 Received: from lists.gnu.org ([2001:470:142::17]:44498) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzCu5-0000of-Cf for submit@debbugs.gnu.org; Sat, 04 Nov 2023 05:25:18 -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 1qzCtO-0007mM-Oz for bug-gnu-emacs@gnu.org; Sat, 04 Nov 2023 05:24:35 -0400 Received: from out-171.mta1.migadu.com ([95.215.58.171]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qzCtN-00084W-49 for bug-gnu-emacs@gnu.org; Sat, 04 Nov 2023 05:24:34 -0400 References: <87bkcexvoy.fsf@jeremybryant.net> <8734xqxstn.fsf@jeremybryant.net> DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jeremybryant.net; s=key1; t=1699089868; 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=1JxML0j4u7uEwZyDvlhTx19ybq5mr2t6M1DKRplXFZ4=; b=eBQGqQRbGMd3ZUjariCTWGgyXxmMm8hAUdtj/lgtzwVkLds85wJ7PuXdEysoBIwvH5fDi9 jzsWWHo2StjF0ghV5bTd1ZbZCYNVtuFZLBLeucou0n0jvn8YZsHMOL5ySeEPi6Btuq6uDK kW85MkJN2mOnF61FvYjQQHKUEL8IjwgrYun86S89ly37jfZIPtWLzmtGwEI+8frenrBdn1 cO6C6ZkK9NnnCTiaqDjQu/P9jMsQUzsHgXfCCIL7cDw5Q+wOGodleHCbSWm93QEKZic6T8 tvCnUj7wgPC8weL2y3XQfSM3xcv754NTEu+coxu5L6c/T1jI6u6CvWMWo5ccKw== X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. From: Jeremy Bryant To: Stefan Monnier Subject: Re: [PATCH] Add two docstrings in cl-macs.el Date: Sat, 04 Nov 2023 09:23:42 +0000 In-reply-to: Message-ID: <87h6m1x450.fsf@jeremybryant.net> MIME-Version: 1.0 Content-Type: text/plain X-Migadu-Flow: FLOW_OUT Received-SPF: pass client-ip=95.215.58.171; envelope-from=jb@jeremybryant.net; helo=out-171.mta1.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 Cc: bug-gnu-emacs@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: -0.1 (/) Thank you, I've made a note on conventions. For this patch, as you have pushed, does this mean this is closed? Stefan Monnier writes: >> From 16298965905b1859aa8a342b98803f4abd6da3f0 Mon Sep 17 00:00:00 2001 >> From: Jeremy Bryant >> Date: Tue, 31 Oct 2023 23:37:10 +0000 >> Subject: [PATCH] Add two docstrings in cl-macs.el > > Thanks, pushed. > >> (defun cl--simple-exprs-p (xs) >> + "Map `cl--simple-expr-p' to each element of list XS." > > This doesn't say how the results of `cl--simple-expr-p` are combined, > it might even suggest they're returned as a list. > I think I would have said something like > > "Like `cl--simple-expr-p' but for a list of expressions." > >> (defun cl--const-expr-p (x) >> + "Check if X is constant (i.e., no side effects or dependencies). >> + >> +See `macroexp-const-p' for similar functionality without cl-lib dependency." > > "Similar" fails to describe the difference :-( > [ Note, I can't blame you: I know the difference but I couldn't come up > with a useful description of it, that is, one that is easier to > understand than the code itself. FWIW I believe the difference is > a latent bug, which is partly why I'd like to delete the function :-) ] > > > Stefan From debbugs-submit-bounces@debbugs.gnu.org Sat Nov 04 06:42:42 2023 Received: (at 66863-done) by debbugs.gnu.org; 4 Nov 2023 10:42:42 +0000 Received: from localhost ([127.0.0.1]:32936 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzE6z-00030f-SA for submit@debbugs.gnu.org; Sat, 04 Nov 2023 06:42:42 -0400 Received: from mail-lj1-x235.google.com ([2a00:1450:4864:20::235]:57853) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1qzE6x-00030Q-1p for 66863-done@debbugs.gnu.org; Sat, 04 Nov 2023 06:42:41 -0400 Received: by mail-lj1-x235.google.com with SMTP id 38308e7fff4ca-2c518a1d83fso38912121fa.3 for <66863-done@debbugs.gnu.org>; Sat, 04 Nov 2023 03:42:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1699094517; x=1699699317; darn=debbugs.gnu.org; h=cc:to:subject:message-id:date:mime-version:references:in-reply-to :from:from:to:cc:subject:date:message-id:reply-to; bh=SIK4DcAMTX4nUeKXCpGltI8QtXQUWz5LUwJnuCdp8FM=; b=dUstLjLbJfb3LubLt7CNwn4yM/ZgvhsVLDMQy5CzXMisuwMVZdQtrvGlxYuVGFPMak U3FAsDMpa/tHhOHS8W+dicx/zP07N7DZoBdch7515PqlRLCUR9e7mHhdghPyQtKD+T4b kN1YgmpXowX8lrIYCyJ+I52HAUfPlf5EYbV4kDbv77rJ/27sWtu9PKwRIV78yahBXu69 U3GriBQ1Vl6SUotvJO+Y1cMqMRjHSGh81caST3vHGoBfDvmjYz2P0qC3R6yGCvmIc+zL YLyZuncaTYznmOh1s3Oc4Ry+MNpTNx42nU3M3bsGbxWQLTmB5YnDy5MVoypuqfhT4S26 ZYXg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1699094517; x=1699699317; h=cc:to:subject:message-id:date:mime-version:references:in-reply-to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=SIK4DcAMTX4nUeKXCpGltI8QtXQUWz5LUwJnuCdp8FM=; b=q+7G4V2jNkHStTytxxeYlpi/maFAD2QOb6l2EUfmP3Dh2wgLkeKgP/ZZPch0unOF7y wfIQ3eoENUSJ+1Ir6BVr9ToKJBADuQI5tVdg5DBShKYde/4iqOTWRBY/P4+a0J7LFMBx gO97vKZ7UZRdcILy3v2g5L+Yd2HcOsbhHgmyxXbltlCYdEbq96n6Kq3hME/npd4786/l OS+14QP3rmjUpftgosloOIp/THiQikimSgEHgesorWINLSObjmFkMICbYNQOgakTLyzk BGbCRh9RU3IdEiLd/9hknTC+nlT3/CT45cDYPmeeH+pme41PiRyJTIKSbXkOLtA0RPhw nc5w== X-Gm-Message-State: AOJu0YwQCM1dc1iljpooZQso+N+F7y43tQgfxitxpM769ywvAwnOQ7FN fN3S0ONaprVgg0aVvBQSETYaQbaZTuenUmyK5gU= X-Google-Smtp-Source: AGHT+IGGhlYdOSRYjiRPLAHbTMFh2c88tDwtbJtFZ1PqVNDUMP8tJk1GySgihx2X/+z6N1PhQARHfeX1Qa9o7nDG84A= X-Received: by 2002:a2e:9b18:0:b0:2c5:17c0:cd53 with SMTP id u24-20020a2e9b18000000b002c517c0cd53mr19783101lji.42.1699094516574; Sat, 04 Nov 2023 03:41:56 -0700 (PDT) Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Sat, 4 Nov 2023 03:41:56 -0700 From: Stefan Kangas In-Reply-To: <87h6m1x450.fsf@jeremybryant.net> References: <87bkcexvoy.fsf@jeremybryant.net> <8734xqxstn.fsf@jeremybryant.net> <87h6m1x450.fsf@jeremybryant.net> MIME-Version: 1.0 Date: Sat, 4 Nov 2023 03:41:56 -0700 Message-ID: Subject: Re: bug#66863: [PATCH] Add two docstrings in cl-macs.el To: Jeremy Bryant , Stefan Monnier Content-Type: text/plain; charset="UTF-8" X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 66863-done Cc: 66863-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: -1.0 (-) Jeremy Bryant via "Bug reports for GNU Emacs, the Swiss army knife of text editors" writes: > Thank you, I've made a note on conventions. For this patch, as you have > pushed, does this mean this is closed? I think so, yes. Now done. From unknown Sat Aug 09 13:08:26 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Sat, 02 Dec 2023 12:24:09 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator