From unknown Thu Aug 14 18:33:08 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#7835 <7835@debbugs.gnu.org> To: bug#7835 <7835@debbugs.gnu.org> Subject: Status: 24.0.50; doc string of `overlay-put' needs to mention the return value Reply-To: bug#7835 <7835@debbugs.gnu.org> Date: Fri, 15 Aug 2025 01:33:08 +0000 retitle 7835 24.0.50; doc string of `overlay-put' needs to mention the retu= rn value reassign 7835 emacs submitter 7835 "Drew Adams" severity 7835 minor tag 7835 fixed thanks From debbugs-submit-bounces@debbugs.gnu.org Wed Jan 12 17:41:15 2011 Received: (at submit) by debbugs.gnu.org; 12 Jan 2011 22:41:15 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Pd9NT-0000IS-2J for submit@debbugs.gnu.org; Wed, 12 Jan 2011 17:41:15 -0500 Received: from eggs.gnu.org ([140.186.70.92]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Pd9NS-0000IH-DK for submit@debbugs.gnu.org; Wed, 12 Jan 2011 17:41:14 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Pd9Uh-0000Jz-Fq for submit@debbugs.gnu.org; Wed, 12 Jan 2011 17:48:45 -0500 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00,RCVD_IN_DNSWL_MED, T_RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 Received: from lists.gnu.org ([199.232.76.165]:51041) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Pd9Uh-0000Jn-A0 for submit@debbugs.gnu.org; Wed, 12 Jan 2011 17:48:43 -0500 Received: from [140.186.70.92] (port=42095 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Pd9Ug-0005uP-Cl for bug-gnu-emacs@gnu.org; Wed, 12 Jan 2011 17:48:43 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Pd9SE-0008Jh-Iz for bug-gnu-emacs@gnu.org; Wed, 12 Jan 2011 17:46:11 -0500 Received: from rcsinet10.oracle.com ([148.87.113.121]:23520) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Pd9SE-0008Jc-A2 for bug-gnu-emacs@gnu.org; Wed, 12 Jan 2011 17:46:10 -0500 Received: from rcsinet13.oracle.com (rcsinet13.oracle.com [148.87.113.125]) by rcsinet10.oracle.com (Switch-3.4.2/Switch-3.4.2) with ESMTP id p0CMk8Qr029793 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Wed, 12 Jan 2011 22:46:09 GMT Received: from acsmt353.oracle.com (acsmt353.oracle.com [141.146.40.153]) by rcsinet13.oracle.com (Switch-3.4.2/Switch-3.4.1) with ESMTP id p0CL70YP021596 for ; Wed, 12 Jan 2011 22:46:04 GMT Received: from abhmt006.oracle.com by acsmt353.oracle.com with ESMTP id 920508961294872350; Wed, 12 Jan 2011 14:45:50 -0800 Received: from dradamslap1 (/130.35.178.194) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Wed, 12 Jan 2011 14:45:50 -0800 From: "Drew Adams" To: Subject: 24.0.50; doc string of `overlay-put' needs to mention the return value Date: Wed, 12 Jan 2011 14:45:50 -0800 Message-ID: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: AcuyqnYzMfUjtcRuTBisTjfbPhrKTQ== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.5994 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) X-Spam-Score: -6.4 (------) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -6.4 (------) Like the Elisp manual, the doc string of `overlay-put' needs to mention that it returns its 3rd arg. In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600) of 2011-01-03 on 3249CTO Windowing system distributor `Microsoft Corp.', version 5.1.2600 configured using `configure --with-gcc (4.4) --no-opt --cflags -Ic:/imagesupport/include' From debbugs-submit-bounces@debbugs.gnu.org Mon Jul 04 11:33:11 2011 Received: (at control) by debbugs.gnu.org; 4 Jul 2011 15:33:11 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qdl94-0004QV-Qx for submit@debbugs.gnu.org; Mon, 04 Jul 2011 11:33:11 -0400 Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qdl93-0004QG-CW for control@debbugs.gnu.org; Mon, 04 Jul 2011 11:33:10 -0400 Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1Qdl8r-0005Tj-Sr for control@debbugs.gnu.org; Mon, 04 Jul 2011 17:32:57 +0200 Date: Mon, 04 Jul 2011 17:32:57 +0200 Message-Id: To: control@debbugs.gnu.org From: Lars Magne Ingebrigtsen Subject: control message for bug #7835 X-MailScanner-ID: 1Qdl8r-0005Tj-Sr X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1310398377.9686@KighZgmfI+10ldHNndMIVQ X-Spam-Status: No X-Spam-Score: -2.8 (--) X-Debbugs-Envelope-To: control X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.8 (--) tags 7835 fixed close 7835 24.1 From debbugs-submit-bounces@debbugs.gnu.org Mon Jul 04 11:39:00 2011 Received: (at 7835) by debbugs.gnu.org; 4 Jul 2011 15:39:00 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QdlEh-0004YX-Lu for submit@debbugs.gnu.org; Mon, 04 Jul 2011 11:38:59 -0400 Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QdlEg-0004YM-Tl for 7835@debbugs.gnu.org; Mon, 04 Jul 2011 11:38:59 -0400 Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1QdlDJ-00079K-Cz; Mon, 04 Jul 2011 17:37:33 +0200 From: Lars Magne Ingebrigtsen To: "Drew Adams" Subject: Re: 24.0.50; doc string of `overlay-put' needs to mention the return value In-Reply-To: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> (Drew Adams's message of "Wed, 12 Jan 2011 14:45:50 -0800") Date: Mon, 04 Jul 2011 17:32:54 +0200 Message-ID: References: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) X-Now-Playing: Joanna Newsom's _Have One On Me (2)_: "Go Long" X-Hashcash: 1:23:110704:drew.adams@oracle.com::+HIw/Wd5V/TX77fV:0000000000000000000000000000000000000000HztV X-Hashcash: 1:23:110704:7835@debbugs.gnu.org::CHKxS4h8v4XmRPnk:00000000000000000000000000000000000000000VtHj MIME-Version: 1.0 Content-Type: text/plain X-MailScanner-ID: 1QdlDJ-00079K-Cz X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1310398654.89574@qbBUeUT6wvWyFoZNDkkqsQ X-Spam-Status: No X-Spam-Score: -2.8 (--) X-Debbugs-Envelope-To: 7835 Cc: 7835@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.8 (--) "Drew Adams" writes: > Like the Elisp manual, the doc string of `overlay-put' needs to mention > that it returns its 3rd arg. Ok; fixed. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ From debbugs-submit-bounces@debbugs.gnu.org Mon Jul 04 14:19:52 2011 Received: (at 7835) by debbugs.gnu.org; 4 Jul 2011 18:19:52 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QdnkN-0002HB-Ve for submit@debbugs.gnu.org; Mon, 04 Jul 2011 14:19:52 -0400 Received: from ironport2-out.teksavvy.com ([206.248.154.183] helo=ironport2-out.pppoe.ca) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QdnkM-0002Gx-SI for 7835@debbugs.gnu.org; Mon, 04 Jul 2011 14:19:51 -0400 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: Av0EAIcDEk5FxIxr/2dsb2JhbABTp3t4iHrBIIY2BJ5chCw X-IronPort-AV: E=Sophos;i="4.65,474,1304308800"; d="scan'208";a="120402608" Received: from 69-196-140-107.dsl.teksavvy.com (HELO pastel.home) ([69.196.140.107]) by ironport2-out.pppoe.ca with ESMTP/TLS/ADH-AES256-SHA; 04 Jul 2011 14:19:45 -0400 Received: by pastel.home (Postfix, from userid 20848) id 1B48558DBA; Mon, 4 Jul 2011 14:19:45 -0400 (EDT) From: Stefan Monnier To: Lars Magne Ingebrigtsen Subject: Re: bug#7835: 24.0.50; doc string of `overlay-put' needs to mention the return value Message-ID: References: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> Date: Mon, 04 Jul 2011 14:19:45 -0400 In-Reply-To: (Lars Magne Ingebrigtsen's message of "Mon, 04 Jul 2011 17:32:54 +0200") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: -2.1 (--) X-Debbugs-Envelope-To: 7835 Cc: Drew Adams , 7835@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.1 (--) >> Like the Elisp manual, the doc string of `overlay-put' needs to mention >> that it returns its 3rd arg. Actually, the right fix would be to not document it. Stefan From debbugs-submit-bounces@debbugs.gnu.org Tue Jul 05 09:37:10 2011 Received: (at 7835) by debbugs.gnu.org; 5 Jul 2011 13:37:10 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qe5oM-0007CV-9U for submit@debbugs.gnu.org; Tue, 05 Jul 2011 09:37:10 -0400 Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1Qe5oA-0007BI-H6 for 7835@debbugs.gnu.org; Tue, 05 Jul 2011 09:37:04 -0400 Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1Qe5nx-0000Na-Ug; Tue, 05 Jul 2011 15:36:45 +0200 From: Lars Magne Ingebrigtsen To: Stefan Monnier Subject: Re: bug#7835: 24.0.50; doc string of `overlay-put' needs to mention the return value In-Reply-To: (Stefan Monnier's message of "Mon, 04 Jul 2011 14:19:45 -0400") Date: Tue, 05 Jul 2011 15:29:49 +0200 Message-ID: References: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) X-Now-Playing: Joanna Newsom's _Have One On Me (2)_: "Go Long" X-Hashcash: 1:23:110705:7835@debbugs.gnu.org::kTJkmvnMunPrdFUL:000000000000000000000000000000000000000000Q/3 X-Hashcash: 1:23:110705:drew.adams@oracle.com::YRK63HumPAor/b9V:0000000000000000000000000000000000000000snwt X-Hashcash: 1:23:110705:monnier@iro.umontreal.ca::VgLDEqre8iR6IWD9:00000000000000000000000000000000000012G37 MIME-Version: 1.0 Content-Type: text/plain X-MailScanner-ID: 1Qe5nx-0000Na-Ug X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1310477806.10988@xplNFIfdRfD0SRh0CCY74A X-Spam-Status: No X-Spam-Score: -2.8 (--) X-Debbugs-Envelope-To: 7835 Cc: Drew Adams , 7835@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.8 (--) Stefan Monnier writes: >>> Like the Elisp manual, the doc string of `overlay-put' needs to mention >>> that it returns its 3rd arg. > > Actually, the right fix would be to not document it. Knowing that you're able to say (push (overlay-put ... ... (get-some-value)) list) sounds useful to me. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ From debbugs-submit-bounces@debbugs.gnu.org Tue Jul 05 15:00:39 2011 Received: (at 7835) by debbugs.gnu.org; 5 Jul 2011 19:00:39 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QeArO-0001AH-T9 for submit@debbugs.gnu.org; Tue, 05 Jul 2011 15:00:39 -0400 Received: from ironport2-out.teksavvy.com ([206.248.154.181] helo=ironport2-out.pppoe.ca) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QeArN-0001A4-O4 for 7835@debbugs.gnu.org; Tue, 05 Jul 2011 15:00:38 -0400 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: Av0EAJZeE05FxIxr/2dsb2JhbABTqAl4y0mGNgSeXIQs X-IronPort-AV: E=Sophos;i="4.65,481,1304308800"; d="scan'208";a="120562130" Received: from 69-196-140-107.dsl.teksavvy.com (HELO pastel.home) ([69.196.140.107]) by ironport2-out.pppoe.ca with ESMTP/TLS/ADH-AES256-SHA; 05 Jul 2011 15:00:31 -0400 Received: by pastel.home (Postfix, from userid 20848) id 08F2A592B2; Tue, 5 Jul 2011 15:00:31 -0400 (EDT) From: Stefan Monnier To: Lars Magne Ingebrigtsen Subject: Re: bug#7835: 24.0.50; doc string of `overlay-put' needs to mention the return value Message-ID: References: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> Date: Tue, 05 Jul 2011 15:00:31 -0400 In-Reply-To: (Lars Magne Ingebrigtsen's message of "Tue, 05 Jul 2011 15:29:49 +0200") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: -2.1 (--) X-Debbugs-Envelope-To: 7835 Cc: Drew Adams , 7835@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.1 (--) >>>> Like the Elisp manual, the doc string of `overlay-put' needs to mention >>>> that it returns its 3rd arg. >> Actually, the right fix would be to not document it. > Knowing that you're able to say > (push (overlay-put ... ... (get-some-value)) list) > sounds useful to me. Looks like bad style to me. Stefan From debbugs-submit-bounces@debbugs.gnu.org Tue Jul 05 15:08:35 2011 Received: (at 7835) by debbugs.gnu.org; 5 Jul 2011 19:08:35 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QeAz4-0001M8-Nu for submit@debbugs.gnu.org; Tue, 05 Jul 2011 15:08:34 -0400 Received: from hermes.netfonds.no ([80.91.224.195]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QeAz1-0001Ls-FY for 7835@debbugs.gnu.org; Tue, 05 Jul 2011 15:08:32 -0400 Received: from cm-84.215.51.58.getinternet.no ([84.215.51.58] helo=quimbies.gnus.org) by hermes.netfonds.no with esmtpsa (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.72) (envelope-from ) id 1QeAyp-0002rQ-5s; Tue, 05 Jul 2011 21:08:19 +0200 From: Lars Magne Ingebrigtsen To: Stefan Monnier Subject: Re: bug#7835: 24.0.50; doc string of `overlay-put' needs to mention the return value In-Reply-To: (Stefan Monnier's message of "Tue, 05 Jul 2011 15:00:31 -0400") Date: Tue, 05 Jul 2011 21:08:16 +0200 Message-ID: References: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> User-Agent: Gnus/5.110018 (No Gnus v0.18) Emacs/24.0.50 (gnu/linux) Face: iVBORw0KGgoAAAANSUhEUgAAADAAAAAwBAMAAAClLOS0AAAAGFBMVEUfHSEJCQtAPEEGBgde WV8MDA66trh7dXovbbKDAAACdklEQVQ4jWWTTW/jIBCGsRsn104c7hQ58bVedu8RouHqj9JcoyqC a2V54e/vYOw20o6iSJ6H950BzRDAoOY7WrIGfpA853OwAr/wYAFQRsClihEmyYzpSgFvCdBqzusQ ENCubOgtAag4plUIYUrgOYGOcl5pHRWTxCJl068KjgpVJYAKuN66pMj5UiMCU9LtZ7KCVBxrhKjo EEQFtl3F07E2dsx4Zi6zAjpYuw164j3PWp8AAObmbpX+ygk/t3YBNBmhkw68uHqCgK6KGchgp+PV j/bBagkXju9nnUAXgZ/T1tsdU8XWrvfQwVob0NvbIN3t9AAwE8YW/x3jt1kxEAMJ+DEP/DTlPCq6 FQQbTo6FKSgmx9ODIqDASqeniW3qaEWH1BUC55S7H0aSHz7QygzzI0qlffji9v4xtoc9AlgA2VVq YkTby9jCHq1wJiJg/a7WE4Pa+7H/Bg1A1te1dxw21o5kAQMRDc0OzFu3ya4ruM8AaLYnW+t23e4H YLsNAgq9vecUFfIF9icEXbSCIwh6csVz7a3MEphrNNwI+h4yqr0L4aW/xLcCIkQjC0E3U2Haygab tVyP8a1E2agnAbVkuCVbbwGnnwF0UeGHGeyc6p3D4SAzgLLR5g+vFTrk5qI7aEmRgNDlL3u1+OSk ff/8S1tyBNqRUgg9/La7wJmBZ1JXqwIBGV5Jzuc91Ey+gUlWAoOSluOQ4m/q63PR/IC259W8COGN KLwXXhCtBPbeIogTr7gY1BnfKQKTNj7telyJYwQoWJLLVqHqiCYJLCfjyE9KyRXERtMeKkwryZ8e gPoJzob/gUQlL2KnERjyGEUxxKv9A12LCazfTXMBAAAAAElFTkSuQmCC X-Now-Playing: Joanna Newsom's _Have One On Me (2)_: "Go Long" X-Hashcash: 1:23:110705:drew.adams@oracle.com::B/1QWiixetmYBUQO:00000000000000000000000000000000000000000oEd X-Hashcash: 1:23:110705:7835@debbugs.gnu.org::D3gZgpvjBols0GfA:00000000000000000000000000000000000000000Eiqs X-Hashcash: 1:23:110705:monnier@iro.umontreal.ca::WwdD9QX3G+jrI/IT:0000000000000000000000000000000000000cATi MIME-Version: 1.0 Content-Type: text/plain X-MailScanner-ID: 1QeAyp-0002rQ-5s X-Netfonds-MailScanner: Found to be clean X-Netfonds-MailScanner-From: larsi@gnus.org MailScanner-NULL-Check: 1310497699.54269@p+po9eLv6msk0KtM42BAzA X-Spam-Status: No X-Spam-Score: -2.8 (--) X-Debbugs-Envelope-To: 7835 Cc: Drew Adams , 7835@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -2.8 (--) Stefan Monnier writes: >>>>> Like the Elisp manual, the doc string of `overlay-put' needs to mention >>>>> that it returns its 3rd arg. >>> Actually, the right fix would be to not document it. >> Knowing that you're able to say >> (push (overlay-put ... ... (get-some-value)) list) >> sounds useful to me. > > Looks like bad style to me. I don't think so. It's how setf and most mutators in Common Lisp work, for instance: MAINT> (setq table (make-hash-table)) # MAINT> (setf (gethash :bar table) :foo) :FOO Or elisp put: (put 'put 'foo 'bar) => bar Now, you may consider `overlay-put' more like `insert', and not like a `setf'-like mutator, but to me I'd be surprised if it didn't act like these other mutators. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ From debbugs-submit-bounces@debbugs.gnu.org Wed Jul 06 00:04:15 2011 Received: (at submit) by debbugs.gnu.org; 6 Jul 2011 04:04:16 +0000 Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QeJLT-0007VT-5S for submit@debbugs.gnu.org; Wed, 06 Jul 2011 00:04:15 -0400 Received: from eggs.gnu.org ([140.186.70.92]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QeJLQ-0007VH-Oc for submit@debbugs.gnu.org; Wed, 06 Jul 2011 00:04:13 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QeJLJ-0002fW-PE for submit@debbugs.gnu.org; Wed, 06 Jul 2011 00:04:07 -0400 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=-4.2 required=5.0 tests=BAYES_00,FREEMAIL_FROM, RCVD_IN_DNSWL_MED,T_RP_MATCHES_RCVD,T_TO_NO_BRKTS_FREEMAIL autolearn=unavailable version=3.3.1 Received: from lists.gnu.org ([140.186.70.17]:36377) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QeJLJ-0002fP-GY for submit@debbugs.gnu.org; Wed, 06 Jul 2011 00:04:05 -0400 Received: from eggs.gnu.org ([140.186.70.92]:32796) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QeJLH-0001NL-NO for bug-gnu-emacs@gnu.org; Wed, 06 Jul 2011 00:04:05 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QeJLG-0002ex-5c for bug-gnu-emacs@gnu.org; Wed, 06 Jul 2011 00:04:03 -0400 Received: from lo.gmane.org ([80.91.229.12]:35431) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QeJLF-0002ep-RO for bug-gnu-emacs@gnu.org; Wed, 06 Jul 2011 00:04:02 -0400 Received: from list by lo.gmane.org with local (Exim 4.69) (envelope-from ) id 1QeJLD-0007iQ-FS for bug-gnu-emacs@gnu.org; Wed, 06 Jul 2011 06:03:59 +0200 Received: from pool-72-95-250-103.pitbpa.east.verizon.net ([72.95.250.103]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Wed, 06 Jul 2011 06:03:59 +0200 Received: from alp.tekin.aker by pool-72-95-250-103.pitbpa.east.verizon.net with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Wed, 06 Jul 2011 06:03:59 +0200 X-Injected-Via-Gmane: http://gmane.org/ To: bug-gnu-emacs@gnu.org From: Alp Aker Subject: Re: bug#7835: 24.0.50; doc string of `overlay-put' needs to mention the return value Date: Wed, 06 Jul 2011 00:03:45 -0400 Lines: 28 Message-ID: References: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Complaints-To: usenet@dough.gmane.org X-Gmane-NNTP-Posting-Host: pool-72-95-250-103.pitbpa.east.verizon.net User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (darwin) Cancel-Lock: sha1:2YLhBOglt5kTSQb9JW0N6/E7QaU= X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.17 X-Spam-Score: -5.9 (-----) X-Debbugs-Envelope-To: submit Cc: larsi@gnus.org, monnier@iro.umontreal.ca X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: debbugs-submit-bounces@debbugs.gnu.org Errors-To: debbugs-submit-bounces@debbugs.gnu.org X-Spam-Score: -5.9 (-----) Lars Magne Ingebrigtsen writes: >> Looks like bad style to me. > > I don't think so. It's how setf and most mutators in Common Lisp > work, for instance: > > MAINT> (setq table (make-hash-table)) > # > MAINT> (setf (gethash :bar table) :foo) > :FOO The point was not that there's something wrong with the value `overlay-put' returns. Rather, the rasion d'être of `overlay-put' is its side effect, and it's bad style to make use of the return value of a function that's called for its side effect(s). If you accept this view, then it's reasonable to say that the return value of such functions needn't be documented, as that encourages people to make use their return values. OTOH, the ubiquity of contructions like: (set (make-local-variable 'foo) 'bar) might be taken as justification for the claim that, in the case of certain functions unique to Elisp, using return values in this way is idiomatic Elisp, and that `overlay-put' is such a function. But that argument strikes me as a weak. From unknown Thu Aug 14 18:33:08 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Wed, 03 Aug 2011 11:24:04 +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