From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Alp Aker Newsgroups: gmane.emacs.bugs Subject: 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 Message-ID: References: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Trace: dough.gmane.org 1309925313 13908 80.91.229.12 (6 Jul 2011 04:08:33 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Wed, 6 Jul 2011 04:08:33 +0000 (UTC) Cc: larsi@gnus.org To: 7835@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Jul 06 06:08:29 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 1QeJPY-0000Sa-BE for geb-bug-gnu-emacs@m.gmane.org; Wed, 06 Jul 2011 06:08:28 +0200 Original-Received: from localhost ([::1]:39320 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QeJPW-0002CM-TB for geb-bug-gnu-emacs@m.gmane.org; Wed, 06 Jul 2011 00:08:27 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:33086) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QeJMG-0001am-KT for bug-gnu-emacs@gnu.org; Wed, 06 Jul 2011 00:05:05 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QeJMF-0002mm-2u for bug-gnu-emacs@gnu.org; Wed, 06 Jul 2011 00:05:04 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:44498) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QeJME-0002mY-J6 for bug-gnu-emacs@gnu.org; Wed, 06 Jul 2011 00:05:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1QeJME-0007WN-0c; Wed, 06 Jul 2011 00:05:02 -0400 X-Loop: help-debbugs@gnu.org In-Reply-To: <5E668727347F4E68A2056C3A3CF23717@us.oracle.com> Resent-From: Alp Aker Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 06 Jul 2011 04:05:01 +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 X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.130992505628862 (code B ref -1); Wed, 06 Jul 2011 04:05:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 6 Jul 2011 04:04:16 +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 1QeJLT-0007VT-5S for submit@debbugs.gnu.org; Wed, 06 Jul 2011 00:04:15 -0400 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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 Original-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/ Original-Lines: 28 Original-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-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Wed, 06 Jul 2011 00:05: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:48061 Archived-At: 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.