From: Bill Wohler <wohler@newt.com>
Subject: Docstring line length
Date: Tue, 20 Dec 2005 13:19:03 -0800 [thread overview]
Message-ID: <10282.1135113543@olgas.newt.com> (raw)
* 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'.
I understand why the first line shouldn't be wider than 67 characters,
but why should most lines not be wider than 60? The reason isn't given
here. Perhaps it should.
--
Bill Wohler <wohler@newt.com> http://www.newt.com/wohler/ GnuPG ID:610BD9AD
Maintainer of comp.mail.mh FAQ and MH-E. Vote Libertarian!
If you're passed on the right, you're in the wrong lane.
next reply other threads:[~2005-12-20 21:19 UTC|newest]
Thread overview: 37+ messages / expand[flat|nested] mbox.gz Atom feed top
2005-12-20 21:19 Bill Wohler [this message]
2005-12-20 23:32 ` Docstring line length Luc Teirlinck
2005-12-20 23:59 ` Drew Adams
2005-12-21 0:00 ` Luc Teirlinck
2005-12-21 0:05 ` Luc Teirlinck
2005-12-21 0:15 ` Drew Adams
2005-12-21 0:13 ` Luc Teirlinck
2005-12-21 0:20 ` Drew Adams
2005-12-21 0:54 ` Luc Teirlinck
2005-12-21 1:37 ` Drew Adams
2005-12-21 7:21 ` Henrik Enberg
2005-12-21 18:52 ` Richard M. Stallman
2005-12-21 20:24 ` Drew Adams
2005-12-21 21:44 ` Lennart Borgman
2005-12-22 5:46 ` Richard M. Stallman
2005-12-22 17:00 ` Legal papers for Emacs contributions (was: Re: Docstring line length) Giorgos Keramidas
2005-12-22 22:21 ` Richard M. Stallman
2005-12-23 2:13 ` Giorgos Keramidas
2005-12-23 0:12 ` Legal papers for Emacs contributions David Kastrup
2005-12-23 2:15 ` Giorgos Keramidas
2005-12-24 2:36 ` Richard M. Stallman
2005-12-22 20:43 ` Docstring line length Juri Linkov
2005-12-22 21:15 ` Lennart Borgman
2005-12-22 21:57 ` Juri Linkov
2005-12-22 22:27 ` link appearance (again) (was: RE: Docstring line length) Drew Adams
2005-12-22 5:47 ` Docstring line length Richard M. Stallman
2005-12-21 3:12 ` Ken Raeburn
2005-12-21 18:51 ` Richard M. Stallman
2005-12-21 4:54 ` Johan Bockgård
2005-12-21 0:59 ` Luc Teirlinck
2005-12-21 1:06 ` Luc Teirlinck
2005-12-21 16:30 ` Bill Wohler
2005-12-21 18:32 ` Drew Adams
2005-12-21 19:18 ` Stefan Monnier
2005-12-21 19:57 ` David Kastrup
2005-12-21 23:10 ` Richard M. Stallman
2005-12-21 5:30 ` Richard M. Stallman
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=10282.1135113543@olgas.newt.com \
--to=wohler@newt.com \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.