From: Drew Adams <drew.adams@oracle.com>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 18478@debbugs.gnu.org
Subject: bug#18478: [Patch] Mention the return value of `clone-indirect-buffer'
Date: Wed, 17 Sep 2014 21:05:24 -0700 (PDT) [thread overview]
Message-ID: <15a58b6b-44ef-47d7-8f34-73ac54b6c16d@default> (raw)
In-Reply-To: <jwv7g11ejpq.fsf-monnier+emacsbugs@gnu.org>
> > FWIW, I don't put a lot of stock in checkdoc, personally. ;-)
>
> Its recommendations shouldn't be heeded blindly, indeed, but the
> 80-columns limit is something that should really be obeyed
> whenever possible.
Agreed wrt respecting doc-string line-length conventions.
But 80 chars is the absolute limit. Doc strings should really be
quite a bit shorter than that. `emacs-lisp-docstring-fill-column'
defaults to 65, for example.
The actual convention is this (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.
next prev parent reply other threads:[~2014-09-18 4:05 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-09-14 22:14 bug#18478: 24.4.50; doc string of `clone-indirect-buffer' Drew Adams
2014-09-17 22:49 ` bug#18478: [Patch] Mention the return value " Tom Willemse
2014-09-17 22:55 ` Drew Adams
2014-09-17 23:11 ` Tom Willemse
2014-09-18 1:47 ` Drew Adams
2014-09-18 2:40 ` Stefan Monnier
2014-09-18 4:05 ` Drew Adams [this message]
2014-09-20 23:50 ` Tom Willemse
2014-09-21 22:10 ` Stefan Monnier
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=15a58b6b-44ef-47d7-8f34-73ac54b6c16d@default \
--to=drew.adams@oracle.com \
--cc=18478@debbugs.gnu.org \
--cc=monnier@iro.umontreal.ca \
/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).