From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Magne Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#7835: 24.0.50; doc string of `overlay-put' needs to mention the return value Date: Tue, 05 Jul 2011 21:08:16 +0200 Message-ID: References: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: dough.gmane.org 1309894268 14615 80.91.229.12 (5 Jul 2011 19:31:08 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Tue, 5 Jul 2011 19:31:08 +0000 (UTC) Cc: 7835@debbugs.gnu.org To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Jul 05 21:31:00 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1QeBKj-0008Ln-I6 for geb-bug-gnu-emacs@m.gmane.org; Tue, 05 Jul 2011 21:30:57 +0200 Original-Received: from localhost ([::1]:43281 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QeBKi-0003su-2I for geb-bug-gnu-emacs@m.gmane.org; Tue, 05 Jul 2011 15:30:56 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:45723) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QeB7L-0008JP-1c for bug-gnu-emacs@gnu.org; Tue, 05 Jul 2011 15:17:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QeB7I-0002O6-Tj for bug-gnu-emacs@gnu.org; Tue, 05 Jul 2011 15:17:06 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:37719) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QeB7H-0002NP-JG for bug-gnu-emacs@gnu.org; Tue, 05 Jul 2011 15:17:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1QeB7G-0002OW-Ow; Tue, 05 Jul 2011 15:17:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Magne Ingebrigtsen Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 05 Jul 2011 19:17:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 7835 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: fixed Original-Received: via spool by 7835-submit@debbugs.gnu.org id=B7835.13098929155220 (code B ref 7835); Tue, 05 Jul 2011 19:17:02 +0000 Original-Received: (at 7835) by debbugs.gnu.org; 5 Jul 2011 19:08:35 +0000 Original-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 Original-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 Original-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 In-Reply-To: (Stefan Monnier's message of "Tue, 05 Jul 2011 15:00:31 -0400") 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 X-MailScanner-ID: 1QeAyp-0002rQ-5s MailScanner-NULL-Check: 1310497699.54269@p+po9eLv6msk0KtM42BAzA X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Tue, 05 Jul 2011 15:17:02 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-Received-From: 140.186.70.43 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.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:48037 Archived-At: 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/