From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Tom Willemse Newsgroups: gmane.emacs.bugs Subject: bug#18478: [Patch] Mention the return value of `clone-indirect-buffer' Date: Thu, 18 Sep 2014 01:11:37 +0200 Message-ID: References: <9cf30244-8e2e-4c74-8cf8-1476ec97c61f@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1410995548 22989 80.91.229.3 (17 Sep 2014 23:12:28 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Wed, 17 Sep 2014 23:12:28 +0000 (UTC) Cc: 18478@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Sep 18 01:12:21 2014 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1XUOOb-0002n9-Od for geb-bug-gnu-emacs@m.gmane.org; Thu, 18 Sep 2014 01:12:21 +0200 Original-Received: from localhost ([::1]:47682 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XUOOb-0002kt-1e for geb-bug-gnu-emacs@m.gmane.org; Wed, 17 Sep 2014 19:12:21 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:43460) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XUOOU-0002jt-AS for bug-gnu-emacs@gnu.org; Wed, 17 Sep 2014 19:12:18 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XUOON-0002qi-4F for bug-gnu-emacs@gnu.org; Wed, 17 Sep 2014 19:12:14 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:52137) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XUOON-0002om-1j for bug-gnu-emacs@gnu.org; Wed, 17 Sep 2014 19:12:07 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1XUOOH-00039n-Lg for bug-gnu-emacs@gnu.org; Wed, 17 Sep 2014 19:12:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Tom Willemse Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 17 Sep 2014 23:12:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 18478 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 18478-submit@debbugs.gnu.org id=B18478.141099550512112 (code B ref 18478); Wed, 17 Sep 2014 23:12:01 +0000 Original-Received: (at 18478) by debbugs.gnu.org; 17 Sep 2014 23:11:45 +0000 Original-Received: from localhost ([127.0.0.1]:43701 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XUOO1-00039I-9z for submit@debbugs.gnu.org; Wed, 17 Sep 2014 19:11:45 -0400 Original-Received: from r0.smtpout1.alwaysdata.com ([176.31.58.0]:41790) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XUONz-00039A-7X for 18478@debbugs.gnu.org; Wed, 17 Sep 2014 19:11:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=alwaysdata.net; s=ryuslash; h=Content-Type:MIME-Version:Message-ID:In-Reply-To:Date:References:Subject:Cc:To:From; bh=vy/f/Z7CHqCEWiMTAY9DSfmS4G0qrrlX/JstLLG/Ftk=; b=cuPBlWivxrt7WYHmEkpEk8RQretap9qL3XK7T/tAzdK7tW07J6mbv0AefrqJkjE9c+iN6EAuXRm4+5hS3994kWjBt4LPxmYAx6IIP7KlaIAjPUBSUs70oqEK148btwSOElV9mcMp2XyZHWMbvDcCQSIHNjGPQXj5JXNBX9R/Jqc=; Original-Received: from [2a02:1812:2193:2c00:f24d:a2ff:fede:451c] (helo=localhost) by smtpout1.alwaysdata.com with esmtpsa (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.77) (envelope-from ) id 1XUONu-0002Dd-0B; Thu, 18 Sep 2014 01:11:38 +0200 In-Reply-To: <9cf30244-8e2e-4c74-8cf8-1476ec97c61f@default> (Drew Adams's message of "Wed, 17 Sep 2014 15:55:14 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.4.50 (gnu/linux) X-alwaysdata-ID: 22006156 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x 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:93444 Archived-At: Hey Drew, Drew Adams writes: >> I've attached a suggestion for mentioning the return value for >> `clone-indirect-buffer'. Please let me know what you think. > > Looks OK to me. You can also simplify it to just "Returns...". Certainly, if that has your preference. I just thought that because it is a new paragraph and the ones before it talk about the meanings of the arguments it would be clearer to explicitly state it's about the function. I actually would have liked to start the docstring off with "Create and return ..." as the docstring for `clone-buffer' does, but checkdoc then started complaining about the line being more than 80 characters long.