From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#18478: [Patch] Mention the return value of `clone-indirect-buffer' Date: Wed, 17 Sep 2014 21:05:24 -0700 (PDT) Message-ID: <15a58b6b-44ef-47d7-8f34-73ac54b6c16d@default> References: <9cf30244-8e2e-4c74-8cf8-1476ec97c61f@default> <4919c10d-ac35-475d-9b66-12deaa8d7fbe@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1411013196 19355 80.91.229.3 (18 Sep 2014 04:06:36 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 18 Sep 2014 04:06:36 +0000 (UTC) Cc: 18478@debbugs.gnu.org To: Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Thu Sep 18 06:06:29 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 1XUSzE-00084n-SI for geb-bug-gnu-emacs@m.gmane.org; Thu, 18 Sep 2014 06:06:28 +0200 Original-Received: from localhost ([::1]:48375 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XUSzE-0005xW-DG for geb-bug-gnu-emacs@m.gmane.org; Thu, 18 Sep 2014 00:06:28 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:54682) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XUSz2-0005wP-6b for bug-gnu-emacs@gnu.org; Thu, 18 Sep 2014 00:06:25 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XUSyt-0000R6-H7 for bug-gnu-emacs@gnu.org; Thu, 18 Sep 2014 00:06:16 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:52234) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XUSyt-0000QI-Dk for bug-gnu-emacs@gnu.org; Thu, 18 Sep 2014 00:06:07 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1XUSyn-00025R-LX for bug-gnu-emacs@gnu.org; Thu, 18 Sep 2014 00:06:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 18 Sep 2014 04:06: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.14110131357984 (code B ref 18478); Thu, 18 Sep 2014 04:06:01 +0000 Original-Received: (at 18478) by debbugs.gnu.org; 18 Sep 2014 04:05:35 +0000 Original-Received: from localhost ([127.0.0.1]:43798 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XUSyN-00024h-2M for submit@debbugs.gnu.org; Thu, 18 Sep 2014 00:05:35 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:28059) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XUSyK-00024U-7s for 18478@debbugs.gnu.org; Thu, 18 Sep 2014 00:05:33 -0400 Original-Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id s8I45Sm4013259 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Thu, 18 Sep 2014 04:05:30 GMT Original-Received: from userz7021.oracle.com (userz7021.oracle.com [156.151.31.85]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s8I45Q43000903 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL); Thu, 18 Sep 2014 04:05:27 GMT Original-Received: from abhmp0013.oracle.com (abhmp0013.oracle.com [141.146.116.19]) by userz7021.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s8I45P0w014249; Thu, 18 Sep 2014 04:05:26 GMT In-Reply-To: X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8.2 (807160) [OL 12.0.6691.5000 (x86)] X-Source-IP: acsinet22.oracle.com [141.146.126.238] 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:93451 Archived-At: > > FWIW, I don't put a lot of stock in checkdoc, personally. ;-) >=20 > Its recommendations shouldn't be heeded blindly, indeed, but the > 80-columns limit is something that should really be obeyed > whenever possible. Agreed wrt respecting doc-string line-length conventions. But 80 chars is the absolute limit. Doc strings should really be=20 quite a bit shorter than that. `emacs-lisp-docstring-fill-column' defaults to 65, for example. The actual convention is this (from (elisp) `Documentation Tips'): Format the documentation string so that it fits in an Emacs window on an 80-column screen. It is a good idea for most lines to be no wider than 60 characters. The first line should not be wider than ^^^^^^^^^^^^^ 67 characters or it will look bad in the output of `apropos'. You can fill the text if that looks good. Emacs Lisp mode fills documentation strings to the width specified by `emacs-lisp-docstring-fill-column'. However, you can sometimes make a documentation string much more readable by adjusting its line breaks with care. Use blank lines between sections if the documentation string is long.