unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: dieter@duenenhof-wilhelm.de, Eli Zaretskii <eliz@gnu.org>
Cc: 19129@debbugs.gnu.org
Subject: bug#19129: 25.0.50; recenter-positions is missing a reference to move-to-window-line-top-bottom
Date: Fri, 21 Nov 2014 07:14:15 -0800 (PST)	[thread overview]
Message-ID: <06151e7f-aaa2-4c36-886b-9754e980a31f@default> (raw)
In-Reply-To: <87wq6p9br6.fsf@vsl28t2g.ww011>

> > In the case in point, I'm guessing you've filled the paragraphs of
> > the doc string, which wasn't really necessary, since the lines were
> > of reasonable length.
> 
> Yes, that's right, but I did it mistakenly because I thought it was
> forgotten and that filling a paragraph would be necessary to be in
> accordance to Elisp coding conventions.
> 
> Now I learned that even though emacs-lisp-docstring-fill-column is
> 65 an 80 column filling might be acceptable!

Uh, not really, IMHO.  80-column filling violates the spirit, if not
completely the letter, of the GNU Emacs coding conventions.

What you did, it sounds like (to me), is fix an additional bug: a
doc-string line that was too long.  I would say thank you (while
still letting you know what Eli said about gratuitous changes).
But I don't speak for Emacs Dev.

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.

The default value of `emacs-lisp-docstring-fill-column' is 65.

80 is the absolute maximum for a line.  Anything longer than 60 is
to be avoided.  Longer than 65 (`emacs-lisp-docstring-fill-column')
should be justified with good reasons, specific to the particular
case at hand.

The part about filling by default but possibly manually adjusting
line breaks to make things more readable should, IMO, explicitly
call out that what is meant is that you can introduce line breaks
at columns **less** than `emacs-lisp-docstring-fill-column'.





  reply	other threads:[~2014-11-21 15:14 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-11-20 22:14 bug#19129: 25.0.50; recenter-positions is missing a reference to move-to-window-line-top-bottom H. Dieter Wilhelm
2014-11-20 22:42 ` Drew Adams
2014-11-20 23:28   ` H. Dieter Wilhelm
2014-11-21  8:08     ` Eli Zaretskii
2014-11-21 10:10       ` H. Dieter Wilhelm
2014-11-21 15:33         ` Eli Zaretskii
2014-11-21  8:04 ` Eli Zaretskii
2014-11-21  8:52   ` H. Dieter Wilhelm
2014-11-21 15:14     ` Drew Adams [this message]
2014-11-21 15:30       ` Eli Zaretskii
2014-11-21 17:05       ` H. Dieter Wilhelm
2014-11-21 21:37       ` H. Dieter Wilhelm
     [not found] <<87r3wxbju9.fsf@vsl28t2g.ww011>
     [not found] ` <<831tox5692.fsf@gnu.org>
     [not found]   ` <<87wq6p9br6.fsf@vsl28t2g.ww011>
     [not found]     ` <<06151e7f-aaa2-4c36-886b-9754e980a31f@default>
     [not found]       ` <<83wq6o370s.fsf@gnu.org>
2014-11-21 15:38         ` Drew Adams

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=06151e7f-aaa2-4c36-886b-9754e980a31f@default \
    --to=drew.adams@oracle.com \
    --cc=19129@debbugs.gnu.org \
    --cc=dieter@duenenhof-wilhelm.de \
    --cc=eliz@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).