all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Emanuel Berg <incal@dataswamp.org>
To: emacs-devel@gnu.org
Subject: Re: master 72b1379f079: Increase `emacs-lisp-docstring-fill-column` to 72
Date: Sun, 04 Feb 2024 02:25:02 +0100	[thread overview]
Message-ID: <87v87558cx.fsf@dataswamp.org> (raw)
In-Reply-To: CADwFkm=40BOXuy7+vmsy_qEr6YsjEuJ1ZLMw93Fdb260jr0GMA@mail.gmail.com

Stefan Kangas wrote:

> The claim that wrapping docstrings to 65 characters in any
> way solves that problem is just wrong. It is the same as
> ignoring the problem, perhaps simply because it happened to
> work on the one screen we bothered to test with (using some
> font and font size, letter spacing, etc.).

Yes, as long as it is hard coded it's gonna be a problem
across platforms.

But there are also advantages with having it hard-coded, e.g.
ascii art, tables and other formatting - that is all put there
manually, so offers complete freedom and precision, to those
that are into such perfectionist/pleasant documentation work.

A solution could be, keep it hard-coded by default.

But introduce an option, "help-wrap-lines" or something like
that, when set, lines will be wrapped automatically when
displayed by the help. In the docstring to the option, it will
say explicitely, "note that this method may not display
docstrings exactly as intended by the docstring writer."

So whenever 80 chars won't work, for example on smartphones if
that is the case right now, one would use that option
if desired.

In general, I like the help system in its simplicity.
Re-writing it from scratch I disencourage from but sure, add
new features to make it more interactive, intuitive
and powerful.

Here are my configuration and extensions, 90 LoC:

  https://dataswamp.org/~incal/emacs-init/help-incal.el

-- 
underground experts united
https://dataswamp.org/~incal




  parent reply	other threads:[~2024-02-04  1:25 UTC|newest]

Thread overview: 41+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <170687730547.552.9673193819426474611@vcs2.savannah.gnu.org>
     [not found] ` <20240202123506.0CEC7C0EFF5@vcs2.savannah.gnu.org>
2024-02-02 14:02   ` master 72b1379f079: Increase `emacs-lisp-docstring-fill-column` to 72 Po Lu
2024-02-02 14:23     ` Stefan Kangas
2024-02-03  3:00       ` Po Lu
2024-02-03  3:09         ` Emanuel Berg
2024-02-03  7:43           ` Po Lu
2024-02-03  8:02             ` Emanuel Berg
2024-02-03  8:53             ` Eli Zaretskii
2024-02-03  9:45               ` Po Lu
2024-02-03 10:33                 ` Emanuel Berg
2024-02-03 11:18                 ` Eli Zaretskii
2024-02-03  9:48               ` Emanuel Berg
2024-02-03 11:23                 ` Eli Zaretskii
2024-02-03 11:57                   ` Emanuel Berg
2024-02-03 12:17                     ` Eli Zaretskii
2024-02-03 12:37                       ` Emanuel Berg
2024-02-03  8:04         ` Adam Porter
2024-02-03  8:25           ` Emanuel Berg
2024-02-03  9:36           ` Po Lu
2024-02-03 10:06             ` Emanuel Berg
2024-02-03 10:28             ` Adam Porter
2024-02-03 10:45               ` Emanuel Berg
2024-02-03 11:04               ` Po Lu
2024-02-03 11:17                 ` Emanuel Berg
2024-02-03 11:45                 ` Adam Porter
2024-02-03 12:34                   ` Emanuel Berg
2024-02-04  4:44                     ` Richard Stallman
2024-02-04  5:17                       ` Emanuel Berg
2024-02-07  3:12                         ` Richard Stallman
2024-02-03 11:13               ` Emanuel Berg
2024-02-03 13:43               ` Eric S Fraga
2024-02-03 21:56             ` Stefan Kangas
2024-02-03  8:31         ` Eli Zaretskii
2024-02-03 10:02           ` Po Lu
2024-02-03 10:16             ` Alfred M. Szmidt
2024-02-03 11:20             ` Eli Zaretskii
2024-02-03 12:12               ` Emanuel Berg
2024-02-03 21:47         ` Stefan Kangas
2024-02-03 23:14           ` Po Lu
2024-02-04  1:28             ` Emanuel Berg
2024-02-04  1:25           ` Emanuel Berg [this message]
2024-02-02 14:35     ` 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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87v87558cx.fsf@dataswamp.org \
    --to=incal@dataswamp.org \
    --cc=emacs-devel@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 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.