unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: bug#4162: 23.1; common doc strings that are too wide
Date: Sun, 16 Aug 2009 14:45:18 -0700	[thread overview]
Message-ID: <61F28AD96E494CA1B463C643417D3B1C@us.oracle.com> (raw)

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 <any directory>
 
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)'
 







         reply	other threads:[~2009-08-16 21:45 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <83eim8e7ar.fsf@gnu.org>
2009-05-05 22:45 ` bug#3227: 23.0.93; doc strings too wide Drew Adams
2010-01-02 17:42   ` bug#3227: marked as done (23.0.93; doc strings too wide) Emacs bug Tracking System
2009-08-16 21:45 ` Drew Adams [this message]
2010-01-02 17:42   ` bug#4162: marked as done (23.1; common doc strings that are " Emacs bug Tracking System
2009-10-07 18:16 ` bug#4668: 23.1; two common doc strings too wide - shows up in most uses of `C-h m' Drew Adams
2010-01-02 17:42   ` bug#4668: marked as done (23.1; two common doc strings too wide - shows up in most uses of `C-h m') Emacs bug Tracking System

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=61F28AD96E494CA1B463C643417D3B1C@us.oracle.com \
    --to=drew.adams@oracle.com \
    --cc=4162@emacsbugs.donarmstrong.com \
    --cc=bug-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).