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#4162: 23.1; common doc strings that are too wide Date: Sun, 16 Aug 2009 14:45:18 -0700 Message-ID: <61F28AD96E494CA1B463C643417D3B1C@us.oracle.com> Reply-To: Drew Adams , 4162@emacsbugs.donarmstrong.com NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1250460435 18437 80.91.229.12 (16 Aug 2009 22:07:15 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 16 Aug 2009 22:07:15 +0000 (UTC) To: Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Aug 17 00:07:08 2009 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1McnsW-0000zV-JU for geb-bug-gnu-emacs@m.gmane.org; Mon, 17 Aug 2009 00:07:05 +0200 Original-Received: from localhost ([127.0.0.1]:45381 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1McnsV-0007bl-MF for geb-bug-gnu-emacs@m.gmane.org; Sun, 16 Aug 2009 18:07:03 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1McnsQ-0007au-LX for bug-gnu-emacs@gnu.org; Sun, 16 Aug 2009 18:06:58 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1McnsL-0007WF-K7 for bug-gnu-emacs@gnu.org; Sun, 16 Aug 2009 18:06:57 -0400 Original-Received: from [199.232.76.173] (port=47485 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1McnsL-0007W7-F7 for bug-gnu-emacs@gnu.org; Sun, 16 Aug 2009 18:06:53 -0400 Original-Received: from mx20.gnu.org ([199.232.41.8]:18045) by monty-python.gnu.org with esmtps (TLS-1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1McnsK-00006I-TL for bug-gnu-emacs@gnu.org; Sun, 16 Aug 2009 18:06:53 -0400 Original-Received: from rzlab.ucr.edu ([138.23.92.77]) by mx20.gnu.org with esmtp (Exim 4.60) (envelope-from ) id 1McnsJ-0004eM-OU for bug-gnu-emacs@gnu.org; Sun, 16 Aug 2009 18:06:52 -0400 Original-Received: from rzlab.ucr.edu (rzlab.ucr.edu [127.0.0.1]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n7GM6nm5015958; Sun, 16 Aug 2009 15:06:50 -0700 Original-Received: (from debbugs@localhost) by rzlab.ucr.edu (8.14.3/8.14.3/Submit) id n7GLt7cr013371; Sun, 16 Aug 2009 14:55:07 -0700 X-Loop: owner@emacsbugs.donarmstrong.com Resent-From: "Drew Adams" Resent-To: bug-submit-list@donarmstrong.com Resent-CC: Emacs Bugs Resent-Date: Sun, 16 Aug 2009 21:55:06 +0000 Resent-Message-ID: Resent-Sender: owner@emacsbugs.donarmstrong.com X-Emacs-PR-Message: report 4162 X-Emacs-PR-Package: emacs X-Emacs-PR-Keywords: Original-Received: via spool by submit@emacsbugs.donarmstrong.com id=B.125045910811812 (code B ref -1); Sun, 16 Aug 2009 21:55:06 +0000 Original-Received: (at submit) by emacsbugs.donarmstrong.com; 16 Aug 2009 21:45:08 +0000 X-Spam-Bayes: score:0.5 Bayes not run. spammytokens:Tokens not available. hammytokens:Tokens not available. Original-Received: from lists.gnu.org (lists.gnu.org [199.232.76.165]) by rzlab.ucr.edu (8.14.3/8.14.3/Debian-5) with ESMTP id n7GLj6SY011766 for ; Sun, 16 Aug 2009 14:45:07 -0700 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1McnXF-000761-TU for bug-gnu-emacs@gnu.org; Sun, 16 Aug 2009 17:45:06 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1McnXB-000737-Fl for bug-gnu-emacs@gnu.org; Sun, 16 Aug 2009 17:45:04 -0400 Original-Received: from [199.232.76.173] (port=34812 helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1McnXA-00072v-IY for bug-gnu-emacs@gnu.org; Sun, 16 Aug 2009 17:45:00 -0400 Original-Received: from rcsinet11.oracle.com ([148.87.113.123]:35632 helo=rgminet11.oracle.com) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1McnXA-00058I-3m for bug-gnu-emacs@gnu.org; Sun, 16 Aug 2009 17:45:00 -0400 Original-Received: from rgminet15.oracle.com (rcsinet15.oracle.com [148.87.113.117]) by rgminet11.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n7GLj6qe011325 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Sun, 16 Aug 2009 21:45:07 GMT Original-Received: from abhmt001.oracle.com (abhmt001.oracle.com [141.146.116.10]) by rgminet15.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id n7GLitQV018317 for ; Sun, 16 Aug 2009 21:44:56 GMT Original-Received: from dradamslap1 (/141.144.88.37) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Sun, 16 Aug 2009 14:44:52 -0700 X-Mailer: Microsoft Office Outlook 11 Thread-Index: AcoeutidB8cvGjIGQ1etRUl36AvSPQ== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.5579 X-Source-IP: abhmt001.oracle.com [141.146.116.10] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A090206.4A887DD5.00C1:SCFSTAT5015188,ss=1,fgs=0 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 1) X-Detected-Operating-System: by mx20.gnu.org: GNU/Linux 2.6 (newer, 2) X-detected-operating-system: by monty-python.gnu.org: Genre and OS details not recognized. Resent-Date: Sun, 16 Aug 2009 18:06:57 -0400 X-BeenThere: bug-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:30276 Archived-At: Doc-string lines should be limited to 70 chars max. This is especially important when windows or frames are automatically resized to fit their widest line. The guideline (Elisp manual, node Documentation Tips) is in fact 60 chars max, or 67 chars max for the first line: 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'. Here are a few of the most prominent doc strings that should be shortened. In some cases, text can be filled to accomplish this. In other cases, the text should be reworded. emacs -Q C-x d Search for "Global-Auto-Composition". The doc string is too wide: 104 chars wide (with another line 85 chars wide, and another 74 chars). Search for "Global-Font-Lock". The doc string is too wide: 90 chars wide (with another line 78 chars wide). Search for "Transient-Mark" The doc string is also too wide: 84 chars (with another line 75 chars wide, another 73 chars, and another 72). Other long lines in this buffer: Font-Lock mode has 5 lines longer than 77 chars, 2 of 77 chars, 2 of 76, 2 of 74, and 2 of 72. Auto-Composition has two lines of 77 chars and one of 76. Auto-Encryption has a line of 72 chars. Dired by name has a line of 73 chars, a line of 72, and a line of 71. Auto-Compression has a line of 73 chars. Blink-Cursor has a line of 73 chars. Other modes, which are not in emacs -Q, but are common anyway: Show-Paren (not in emacs -Q), but common anyway) has a line of 74 chars and two lines of 72. Savehist has a line of 72 chars. In GNU Emacs 23.1.1 (i386-mingw-nt5.1.2600) of 2009-07-29 on SOFT-MJASON Windowing system distributor `Microsoft Corp.', version 5.1.2600 configured using `configure --with-gcc (4.4)'