unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Emanuel Berg <embe8573@student.uu.se>, help-gnu-emacs@gnu.org
Subject: RE: Is Emacs very alive, active and improving?
Date: Thu, 29 Aug 2013 14:05:39 -0700 (PDT)	[thread overview]
Message-ID: <d460f1d4-1525-4824-b4f4-aff49da5127b@default> (raw)
In-Reply-To: <87d2oww758.fsf@nl106-137-194.student.uu.se>

> I agree the whole framework around the Emacs documentation is
> great, apart from one thing, that you (or somebody else) possibly
> can help me with:
> 
> When I bring up the help for find-file (just an example, this
> happens all the time), some of the lines are too long. For
> example, one line looks like this:
> 
> Interactively, [cut] type RET is the current director
> 
> That is, "y," has overflowed the width. Is there a way to "fill"
> all help? I tried to manually change some of the docstrings with
> line breaks ("\n", same as in C, or otherwise in Elisp
> strings). That worked, but I'm not going to do that for each and
> any function (or whatever).

Doc strings are supposed to be shorter that some limit.
(elisp) `Documentation Tips' says this:

  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.  However, rather than
  blindly filling the entire documentation string, you can often
  make it much more readable by choosing certain line breaks with
  care.  Use blank lines between sections if the documentation
  string is long.

Likewise, *Help* output, in general.

Wrt filling doc strings, see also user option
`emacs-lisp-docstring-fill-column'.

It sometimes happens that someone writes a doc string that is too
wide.  That is what `M-x report-emacs-bug' is for.



  reply	other threads:[~2013-08-29 21:05 UTC|newest]

Thread overview: 113+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-08-26 22:43 Is Emacs very alive, active and improving? Jorge Peixoto de Morais Neto
2013-08-27  0:05 ` Perry Smith
2013-08-27  0:25   ` Jorge Peixoto de Morais Neto
2013-08-27  9:07 ` Peter Dyballa
2013-08-27 23:52 ` Suvayu Ali
2013-08-28  3:03   ` Yagnesh Raghava Yakkala
2013-08-29  0:39     ` Suvayu Ali
2013-08-28 20:19 ` Ken Goldman
2013-08-29  0:25   ` Stefan Monnier
     [not found] ` <mailman.904.1377721211.10748.help-gnu-emacs@gnu.org>
2013-08-28 20:53   ` Emanuel Berg
2013-10-03 19:25     ` Ken Goldman
     [not found]     ` <mailman.3330.1380828355.10748.help-gnu-emacs@gnu.org>
2013-10-03 19:58       ` Emanuel Berg
2013-08-28 21:09 ` W. Greenhouse
     [not found] ` <mailman.907.1377724222.10748.help-gnu-emacs@gnu.org>
2013-08-28 21:55   ` Emanuel Berg
2013-08-29  2:04     ` Kevin Montuori
     [not found]     ` <mailman.935.1377741861.10748.help-gnu-emacs@gnu.org>
2013-08-29  2:55       ` Emanuel Berg
2013-08-29  3:06         ` Emanuel Berg
2013-08-29  7:59     ` W. Greenhouse
     [not found]     ` <mailman.943.1377763221.10748.help-gnu-emacs@gnu.org>
2013-08-29 20:53       ` Emanuel Berg
2013-08-29 21:05         ` Drew Adams [this message]
     [not found]         ` <mailman.992.1377810361.10748.help-gnu-emacs@gnu.org>
2013-08-29 21:24           ` Emanuel Berg
2013-08-29 23:37             ` Drew Adams
     [not found]             ` <mailman.996.1377819467.10748.help-gnu-emacs@gnu.org>
2013-08-30  0:25               ` Emanuel Berg
2013-08-29 22:47           ` Emanuel Berg
2013-08-30  6:09         ` Eli Zaretskii
2013-08-30  1:32     ` MBR
     [not found]     ` <mailman.999.1377826390.10748.help-gnu-emacs@gnu.org>
2013-08-30  2:26       ` Emanuel Berg
2013-08-30 11:58         ` Stefan Monnier
2013-08-30 12:21     ` Ludwig, Mark
2013-08-30 13:28       ` Eli Zaretskii
2013-08-29 23:50 ` Jorge Peixoto de Morais Neto
     [not found] ` <mailman.997.1377820262.10748.help-gnu-emacs@gnu.org>
2013-08-30  0:28   ` Emanuel Berg
2013-08-30  1:23     ` Jorge
     [not found]     ` <mailman.998.1377825809.10748.help-gnu-emacs@gnu.org>
2013-08-30  2:22       ` Emanuel Berg
2013-08-30  6:31         ` Eli Zaretskii
2013-08-30 16:24         ` Jorge
2013-10-04 11:30 ` Luca Ferrari
2013-10-04 21:59   ` Jude DaShiell
2013-10-04 23:16     ` Bob Proulx
     [not found]     ` <mailman.3434.1380928592.10748.help-gnu-emacs@gnu.org>
2013-10-04 23:35       ` Emanuel Berg
2013-10-06 12:07         ` Rustom Mody
2013-10-06 21:50           ` Evans Winner
2013-10-09 19:41             ` Emanuel Berg
2013-10-10  4:27               ` Teemu Likonen
     [not found]               ` <mailman.3736.1381379296.10748.help-gnu-emacs@gnu.org>
2013-10-10  5:25                 ` Rustom Mody
2013-10-10  8:24                   ` Andreas Röhler
2013-10-10 22:18                     ` Bob Proulx
2013-10-11 10:39                       ` Andreas Röhler
2013-10-10 10:36                   ` Phillip Lord
2013-10-10 11:00                     ` Rainer M Krug
2013-10-10 15:16                       ` Peter Dyballa
2013-10-11 11:06                       ` Phillip Lord
2013-10-12 22:01                         ` Christopher Ritsen
2013-10-14 11:04                           ` Phillip Lord
2013-10-14 16:50                             ` Stefan Monnier
2013-10-14 19:25                             ` Christopher Ritsen
2013-10-15 11:30                               ` Phillip Lord
     [not found]                               ` <mailman.4032.1381836640.10748.help-gnu-emacs@gnu.org>
2013-10-15 17:56                                 ` Emanuel Berg
     [not found]                             ` <mailman.3989.1381778782.10748.help-gnu-emacs@gnu.org>
2013-10-14 21:54                               ` Emanuel Berg
2013-10-15  6:27                                 ` Bob Proulx
     [not found]                                 ` <mailman.4022.1381818464.10748.help-gnu-emacs@gnu.org>
2013-10-15 17:50                                   ` Emanuel Berg
2013-10-16  4:56                                     ` Rustom Mody
2013-10-17  1:45                                       ` Emanuel Berg
     [not found]                         ` <mailman.3906.1381619521.10748.help-gnu-emacs@gnu.org>
2013-10-13  2:36                           ` Rustom Mody
2013-10-10 13:04                   ` Carson Chittom
     [not found]                   ` <mailman.3784.1381425760.10748.help-gnu-emacs@gnu.org>
2013-10-10 20:44                     ` Emanuel Berg
     [not found]                   ` <mailman.3742.1381393368.10748.help-gnu-emacs@gnu.org>
2013-10-10 20:57                     ` Emanuel Berg
2013-10-11 10:56                       ` Andreas Röhler
2013-10-11 19:06                         ` Bob Proulx
2013-10-12  7:48                           ` Andreas Röhler
     [not found]                           ` <mailman.3875.1381563966.10748.help-gnu-emacs@gnu.org>
2013-10-12 20:24                             ` Emanuel Berg
2013-10-10 23:54                   ` Emanuel Berg
2013-10-11  0:05                     ` Emanuel Berg
2013-10-11  5:58                       ` Thien-Thi Nguyen
     [not found]                       ` <mailman.3818.1381470912.10748.help-gnu-emacs@gnu.org>
2013-10-11 17:20                         ` Emanuel Berg
2013-10-09 19:31           ` Emanuel Berg
2013-10-10  2:28             ` Rustom Mody
2013-10-09 21:30         ` Tom Davey
     [not found]         ` <mailman.3718.1381354235.10748.help-gnu-emacs@gnu.org>
2013-10-09 21:51           ` Emanuel Berg
2013-10-10 16:24         ` henry atting
2013-10-11  5:19         ` Eric Abrahamsen
     [not found] ` <mailman.3391.1380886224.10748.help-gnu-emacs@gnu.org>
2013-10-04 17:45   ` Emanuel Berg
2013-10-04 19:28     ` Thien-Thi Nguyen
     [not found]     ` <mailman.3429.1380914709.10748.help-gnu-emacs@gnu.org>
2013-10-04 20:18       ` Emanuel Berg
2013-10-08 11:36     ` Rustom Mody
2013-10-09 19:43       ` Emanuel Berg
     [not found] ` <mailman.815.1377561963.10748.help-gnu-emacs@gnu.org>
2013-10-13 14:47   ` Eric Brown
2013-10-13 15:08     ` Emanuel Berg
2013-10-13 17:52       ` Eric Brown
2013-10-13 18:13     ` Alex Schroeder
2013-10-13 19:23       ` Emanuel Berg
     [not found] <mailman.811.1377557346.10748.help-gnu-emacs@gnu.org>
2013-08-27  1:44 ` Rustom Mody
2013-08-27 23:59 ` Emanuel Berg
2013-08-28  0:20   ` Marko Vojinovic
2013-08-28  1:56     ` Stefan Monnier
     [not found]     ` <mailman.880.1377655035.10748.help-gnu-emacs@gnu.org>
2013-08-28  1:59       ` Emanuel Berg
2013-08-28  0:35   ` Marc Weber
     [not found]   ` <mailman.874.1377650119.10748.help-gnu-emacs@gnu.org>
2013-08-28  1:08     ` Emanuel Berg
2013-08-28  3:25       ` Marc Weber
     [not found]       ` <mailman.883.1377660293.10748.help-gnu-emacs@gnu.org>
2013-08-28  4:08         ` Rustom Mody
2013-08-28 20:48           ` Emanuel Berg
2013-08-28 20:37         ` Emanuel Berg
2013-08-28  1:39   ` Jorge
2013-10-12 13:39 ` Kai Grossjohann
2013-10-12 15:30   ` Drew Adams
2013-10-12 20:39   ` Emanuel Berg
2013-10-12 20:57     ` Kai Grossjohann
2013-10-12 20:58     ` Emanuel Berg
     [not found]   ` <mailman.3883.1381591837.10748.help-gnu-emacs@gnu.org>
2013-10-12 21:01     ` Kai Grossjohann
2013-10-12 21:14       ` Drew Adams
2013-10-12 21:15       ` Emanuel Berg
2013-10-13 13:33         ` Kai Großjohann
     [not found]         ` <mailman.3924.1381671200.10748.help-gnu-emacs@gnu.org>
2013-10-13 15:25           ` Emanuel Berg

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=d460f1d4-1525-4824-b4f4-aff49da5127b@default \
    --to=drew.adams@oracle.com \
    --cc=embe8573@student.uu.se \
    --cc=help-gnu-emacs@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.
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).