GNU bug report logs - #17999
24.4.50; `define-minor-mode' creates doc-string lines that are far too long

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Fri, 11 Jul 2014 17:48:02 UTC

Severity: minor

Tags: fixed

Found in version 24.4.50

Fixed in version 26.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 17999 in the body.
You can then email your comments to 17999 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#17999; Package emacs. (Fri, 11 Jul 2014 17:48:02 GMT) Full text and rfc822 format available.
Acknowledgement sent to Drew Adams <drew.adams <at> oracle.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Fri, 11 Jul 2014 17:48:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.4.50; `define-minor-mode' creates doc-string lines that are far
 too long
Date: Fri, 11 Jul 2014 10:46:50 -0700 (PDT)

The automatically created doc string for the user option has a line like
this, which can easily be far too long (it is unwrapped, though it might
appear wrapped in this bug report):

See the command `libprefix-the-possibly-long-mode-command-name' for a description of this minor mode.

The line should be split after the command name.  Or (better) the line
should be automatically filled (wrapped as needed).  To save some
veribage you can also remove "the" from "the command" and "minor" from
"minor mode".

As a general rule, any macro that defines a function or variable should
take care to create doc strings that are not longer than convention.


In GNU Emacs 24.4.50.1 (i686-pc-mingw32)
 of 2014-06-28 on ODIEONE
Bzr revision: 117431 rgm <at> gnu.org-20140628015517-eku6hj8mpgcvfnso
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/Devel/emacs/snapshot/trunk
 --enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
 LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
 -Ic:/Devel/emacs/include''
Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#17999; Package emacs. (Fri, 29 Apr 2016 21:26:02 GMT) Full text and rfc822 format available.

Message #8 received at 17999 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 17999 <at> debbugs.gnu.org
Subject: Re: bug#17999: 24.4.50;
 `define-minor-mode' creates doc-string lines that are far too long
Date: Fri, 29 Apr 2016 23:25:22 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> The automatically created doc string for the user option has a line like
> this, which can easily be far too long (it is unwrapped, though it might
> appear wrapped in this bug report):
>
> See the command `libprefix-the-possibly-long-mode-command-name' for a description of this minor mode.
>
> The line should be split after the command name.

I've now pushed a fix for this.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no
Added tag(s) fixed. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Fri, 29 Apr 2016 21:26:02 GMT) Full text and rfc822 format available.
bug marked as fixed in version 25.2, send any further explanations to 17999 <at> debbugs.gnu.org and Drew Adams <drew.adams <at> oracle.com> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Fri, 29 Apr 2016 21:26:02 GMT) Full text and rfc822 format available.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sat, 28 May 2016 11:24:10 GMT) Full text and rfc822 format available.
bug unarchived. Request was from Glenn Morris <rgm <at> gnu.org> to control <at> debbugs.gnu.org. (Sun, 04 Dec 2016 02:50:05 GMT) Full text and rfc822 format available.
bug Marked as fixed in versions 26.1. Request was from Glenn Morris <rgm <at> gnu.org> to control <at> debbugs.gnu.org. (Sun, 04 Dec 2016 02:50:05 GMT) Full text and rfc822 format available.
bug No longer marked as fixed in versions 25.2. Request was from Glenn Morris <rgm <at> gnu.org> to control <at> debbugs.gnu.org. (Sun, 04 Dec 2016 02:50:05 GMT) Full text and rfc822 format available.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sun, 01 Jan 2017 12:24:27 GMT) Full text and rfc822 format available.
This bug report was last modified 8 years and 165 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.