bug#3227: 23.0.93; doc strings too wide

bug#3227: 23.0.93; doc strings too wide

[Drew Adams]

The doc strings of the following variables are not formatted
correctly. Their longest lines have these many chars (all are > 80):
 
* byte-catch: 85 chars
* byte-constant2: 86
* byte-save-restriction: 86
* byte-unwind-protect: 91
* color-themes: 83
* cpp-font-lock-keywords-source-depth: 95
* default-indicate-buffer-boundaries: 81
* dmoccur-exclusion-mask: 88
* ediff-after-flag-eol: 85
* ediff-before-flag-bol: 94
* ediff-before-flag-mol: 83
* ediff-cleanup-hook: 81
* ediff-default-filtering-regexp: 82
* ediff-ignore-similar-regions: 88
* ediff-metachars: 82
* ediff-mouse-pixel-threshold: 95
* ediff-show-clashes-only: 81
* ediff-startup-hook: 88
* global-auto-composition-mode: 84
* global-highlight-changes-mode: 85
* global-whitespace-newline-mode: 86
* minibuffer-depth-indicate-mode: 86
* minibuffer-electric-default-mode: 88
* minibuffer-history-case-insensitive-variables: 149
* minibuffer-local-filename-must-match-map: 81
* redisplay-end-trigger-functions: 81
* thing-at-point-url-path-regexp: 85
* unify-8859-on-decoding-mode:83
* unify-8859-on-encoding-mode: 83
* view-exit-action: 81
 
Likewise, for the following functions:
 
* /=: 83 chars
* >: 83
* abbrev-with-wrapper-hook: 83
* allout-mode: 105
* array-mode: 93
* artist-mode: 119
* autoarg-mode: 82
* bibtex-mode: 102
* bookmark-bmenu-other-window-with-mouse: 84
* checkdoc-minor-mode: 84
* comint-mode: 123
* comment-indent-new-line: 85
* completing-read-multiple: 95
* constrain-to-field: 85
* cperl-mode: 149
* decipher-mode: 104
* define-generic-mode: 99
* define-ibuffer-op: 115
* diff-mode: 89
* ediff-merge-buffers-with-ancestor: 89
* ediff-merge-directories-with-ancestor: 82
* ediff-merge-directory-revisions-with-ancestor: 85
* ediff-re-merge: 84
* ediff-toggle-show-clashes-only: 95
* edir-merge-revisions-with-ancestor: 85
* edirs-merge-with-ancestor: 82
* edit-picture: 90
* erc: 136
* erc-select: 136
* face-attribute-specified-or: 91
* face-equal: 81
* feedmail-queue-reminder: 82
* flyspell-mode: 88
* global-auto-composition-mode: 85
* global-cwarn-mode: 87
* global-font-lock-mode: 90
* global-hi-lock-mode: 86
* global-highlight-changes-mode: 86
* global-visual-line-mode: 88
* gnus-msg-mail: 87
* hexl-mode: 150
* hi-lock-mode: 103
* ibuffer: 83
* ido-find-file: 115
* indent-new-comment-line: 85
* internal-lisp-face-equal-p: 81
* kill-line: 108
* kmacro-set-counter: 81
* kmacro-step-edit-macro: 81
* make-byte-code: 90
* make-frame: 83
* message-mail: 89
* mh-user-agent-compose: 89
* new-frame: 83
* next-single-char-property-change: 84
* nxml-mode: 93
* octave-mode: 90
* outline-mode: 95
* pascal-mode: 97
* picture-mode: 90
* previous-single-char-property-change: 88
* python-mode: 82
* quail-define-package: 232
* read-key-sequence: 91
* read-key-sequence-vector: 91
* reftex-index-phrases-mode: 84
* reftex-mode: 99
* rmail-mode: 101
* same-window-p: 81
* sh-mode: 90
* shell-script-mode: 90
* table-capture: 92
* table-insert: 115
* table-split-cell-horizontally: 81
* toggle-transient-mark-mode: 116
* verilog-mode: 102
* w32-shell-dos-semantics: 82
 
Caveat: Some of these long lines (in particular, those with names
"*-mode") will not appear too long when displayed in the proper mode -
e.g. \\[...]  strings that I saw as `M-x...' but which are normally
displayed as shorter key bindings. Nevertheless, they are all probably
worth checking, to be sure.
 

In GNU Emacs 23.0.93.1 (i386-mingw-nt5.1.2600)
 of 2009-05-02 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4)'
 

bug#3227: marked as done (23.0.93; doc strings too wide)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 844 bytes --]

Your message dated Sat, 02 Jan 2010 19:38:20 +0200
with message-id <83eim8e7ar.fsf@gnu.org>
and subject line Re: 23.1; two common doc strings too wide - shows up in most uses of `C-h m'
has caused the Emacs bug report #4668,
regarding 23.0.93; doc strings too wide
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact bug-gnu-emacs@gnu.org
immediately.)


-- 
4668: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=4668
Emacs Bug Tracking System
Contact bug-gnu-emacs@gnu.org with problems

[-- Attachment #2: Type: message/rfc822, Size: 6228 bytes --]

From: "Drew Adams" <drew.adams@oracle.com>
To: <emacs-pretest-bug@gnu.org>
Subject: 23.0.93; doc strings too wide
Date: Tue, 5 May 2009 15:45:18 -0700
Message-ID: <003c01c9cdd3$2b159cc0$0200a8c0@us.oracle.com>

The doc strings of the following variables are not formatted
correctly. Their longest lines have these many chars (all are > 80):
 
* byte-catch: 85 chars
* byte-constant2: 86
* byte-save-restriction: 86
* byte-unwind-protect: 91
* color-themes: 83
* cpp-font-lock-keywords-source-depth: 95
* default-indicate-buffer-boundaries: 81
* dmoccur-exclusion-mask: 88
* ediff-after-flag-eol: 85
* ediff-before-flag-bol: 94
* ediff-before-flag-mol: 83
* ediff-cleanup-hook: 81
* ediff-default-filtering-regexp: 82
* ediff-ignore-similar-regions: 88
* ediff-metachars: 82
* ediff-mouse-pixel-threshold: 95
* ediff-show-clashes-only: 81
* ediff-startup-hook: 88
* global-auto-composition-mode: 84
* global-highlight-changes-mode: 85
* global-whitespace-newline-mode: 86
* minibuffer-depth-indicate-mode: 86
* minibuffer-electric-default-mode: 88
* minibuffer-history-case-insensitive-variables: 149
* minibuffer-local-filename-must-match-map: 81
* redisplay-end-trigger-functions: 81
* thing-at-point-url-path-regexp: 85
* unify-8859-on-decoding-mode:83
* unify-8859-on-encoding-mode: 83
* view-exit-action: 81
 
Likewise, for the following functions:
 
* /=: 83 chars
* >: 83
* abbrev-with-wrapper-hook: 83
* allout-mode: 105
* array-mode: 93
* artist-mode: 119
* autoarg-mode: 82
* bibtex-mode: 102
* bookmark-bmenu-other-window-with-mouse: 84
* checkdoc-minor-mode: 84
* comint-mode: 123
* comment-indent-new-line: 85
* completing-read-multiple: 95
* constrain-to-field: 85
* cperl-mode: 149
* decipher-mode: 104
* define-generic-mode: 99
* define-ibuffer-op: 115
* diff-mode: 89
* ediff-merge-buffers-with-ancestor: 89
* ediff-merge-directories-with-ancestor: 82
* ediff-merge-directory-revisions-with-ancestor: 85
* ediff-re-merge: 84
* ediff-toggle-show-clashes-only: 95
* edir-merge-revisions-with-ancestor: 85
* edirs-merge-with-ancestor: 82
* edit-picture: 90
* erc: 136
* erc-select: 136
* face-attribute-specified-or: 91
* face-equal: 81
* feedmail-queue-reminder: 82
* flyspell-mode: 88
* global-auto-composition-mode: 85
* global-cwarn-mode: 87
* global-font-lock-mode: 90
* global-hi-lock-mode: 86
* global-highlight-changes-mode: 86
* global-visual-line-mode: 88
* gnus-msg-mail: 87
* hexl-mode: 150
* hi-lock-mode: 103
* ibuffer: 83
* ido-find-file: 115
* indent-new-comment-line: 85
* internal-lisp-face-equal-p: 81
* kill-line: 108
* kmacro-set-counter: 81
* kmacro-step-edit-macro: 81
* make-byte-code: 90
* make-frame: 83
* message-mail: 89
* mh-user-agent-compose: 89
* new-frame: 83
* next-single-char-property-change: 84
* nxml-mode: 93
* octave-mode: 90
* outline-mode: 95
* pascal-mode: 97
* picture-mode: 90
* previous-single-char-property-change: 88
* python-mode: 82
* quail-define-package: 232
* read-key-sequence: 91
* read-key-sequence-vector: 91
* reftex-index-phrases-mode: 84
* reftex-mode: 99
* rmail-mode: 101
* same-window-p: 81
* sh-mode: 90
* shell-script-mode: 90
* table-capture: 92
* table-insert: 115
* table-split-cell-horizontally: 81
* toggle-transient-mark-mode: 116
* verilog-mode: 102
* w32-shell-dos-semantics: 82
 
Caveat: Some of these long lines (in particular, those with names
"*-mode") will not appear too long when displayed in the proper mode -
e.g. \\[...]  strings that I saw as `M-x...' but which are normally
displayed as shorter key bindings. Nevertheless, they are all probably
worth checking, to be sure.
 

In GNU Emacs 23.0.93.1 (i386-mingw-nt5.1.2600)
 of 2009-05-02 on SOFT-MJASON
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4)'
 




[-- Attachment #3: Type: message/rfc822, Size: 2154 bytes --]

From: Eli Zaretskii <eliz@gnu.org>
To: 4668-done@debbugs.gnu.org
Subject: Re: 23.1; two common doc strings too wide - shows up in most uses of `C-h m'
Date: Sat, 02 Jan 2010 19:38:20 +0200
Message-ID: <83eim8e7ar.fsf@gnu.org>

Thanks, I made the lines shorter in the template used for
auto-generated doc strings.

bug#4162: 23.1; common doc strings that are too wide

[Drew Adams]

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

bug#4162: marked as done (23.1; common doc strings that are too wide)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 857 bytes --]

Your message dated Sat, 02 Jan 2010 19:38:20 +0200
with message-id <83eim8e7ar.fsf@gnu.org>
and subject line Re: 23.1; two common doc strings too wide - shows up in most uses of `C-h m'
has caused the Emacs bug report #4668,
regarding 23.1; common doc strings that are too wide
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact bug-gnu-emacs@gnu.org
immediately.)


-- 
4668: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=4668
Emacs Bug Tracking System
Contact bug-gnu-emacs@gnu.org with problems

[-- Attachment #2: Type: message/rfc822, Size: 4648 bytes --]

From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: 23.1; common doc strings that are too wide
Date: Sun, 16 Aug 2009 14:45:18 -0700
Message-ID: <61F28AD96E494CA1B463C643417D3B1C@us.oracle.com>

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




[-- Attachment #3: Type: message/rfc822, Size: 2154 bytes --]

From: Eli Zaretskii <eliz@gnu.org>
To: 4668-done@debbugs.gnu.org
Subject: Re: 23.1; two common doc strings too wide - shows up in most uses of `C-h m'
Date: Sat, 02 Jan 2010 19:38:20 +0200
Message-ID: <83eim8e7ar.fsf@gnu.org>

Thanks, I made the lines shorter in the template used for
auto-generated doc strings.

bug#4668: 23.1; two common doc strings too wide - shows up in most uses of `C-h m'

[Drew Adams]

These doc strings are much wider than the convention calls for:
 
global-auto-composition-mode (104 chars)
global-font-lock-mode (90 chars; other lines are also too long)
 
These two appear in nearly every use of `C-h m', making the help display
much wider than is called for.


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

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]

[-- Attachment #1: Type: text/plain, Size: 887 bytes --]

Your message dated Sat, 02 Jan 2010 19:38:20 +0200
with message-id <83eim8e7ar.fsf@gnu.org>
and subject line Re: 23.1; two common doc strings too wide - shows up in most uses of `C-h m'
has caused the Emacs bug report #4668,
regarding 23.1; two common doc strings too wide - shows up in most uses of `C-h m'
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact bug-gnu-emacs@gnu.org
immediately.)


-- 
4668: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=4668
Emacs Bug Tracking System
Contact bug-gnu-emacs@gnu.org with problems

[-- Attachment #2: Type: message/rfc822, Size: 3332 bytes --]

From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: 23.1; two common doc strings too wide - shows up in most uses of `C-h m'
Date: Wed, 7 Oct 2009 11:16:41 -0700
Message-ID: <D4330A5C392F48F5935E4D40D5A83DCD@us.oracle.com>

These doc strings are much wider than the convention calls for:
 
global-auto-composition-mode (104 chars)
global-font-lock-mode (90 chars; other lines are also too long)
 
These two appear in nearly every use of `C-h m', making the help display
much wider than is called for.


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




[-- Attachment #3: Type: message/rfc822, Size: 2154 bytes --]

From: Eli Zaretskii <eliz@gnu.org>
To: 4668-done@debbugs.gnu.org
Subject: Re: 23.1; two common doc strings too wide - shows up in most uses of `C-h m'
Date: Sat, 02 Jan 2010 19:38:20 +0200
Message-ID: <83eim8e7ar.fsf@gnu.org>

Thanks, I made the lines shorter in the template used for
auto-generated doc strings.