]> git.eshelyaron.com Git - emacs.git/commit
Increase `emacs-lisp-docstring-fill-column` to 72
authorStefan Kangas <stefankangas@gmail.com>
Fri, 2 Feb 2024 11:28:54 +0000 (12:28 +0100)
committerEshel Yaron <me@eshelyaron.com>
Sun, 4 Feb 2024 11:04:13 +0000 (12:04 +0100)
commit37814f0ec3d058b39512073c31733fc25602b8ba
tree9748a4eb7bcf0b11a64b9935666f002f2ce98f50
parentf4582d164abb4313e32a3f5501a17d86e9e91d90
Increase `emacs-lisp-docstring-fill-column` to 72

Monitors are wider now than when these defaults were first set, and it
is useful to take better advantage of that, to fit text on fewer lines.
Yet, it has repeatedly been shown that overly long lines reduce
readability:
   "A reasonable guideline would be 55 to 75 characters per line."[1]

We also don't want to disfavor narrow displays, like mobile phones; a
more promising direction here might be to automatically word wrap
docstrings and make their maximum width customizable.  That might
require a new docstring format, however.

Bumping it by 7 characters, from 65 to 72, seems a reasonable compromise
for now.  Consideration was given to increasing it to 70 or 75, but 72
happens to be a commonly recommended maximum line width elsewhere (see
Fortran 66, Python docstrings, commit message recommendations, etc.),
and we might as well do the same.

This change was discussed in:
https://lists.gnu.org/r/emacs-devel/2022-07/msg00217.html

[1] "Optimal Line Length in Reading — A Literature Review", Nanavati and
    Bias, Visible Language, Vol. 39 No. 2 (2005).
    https://journals.uc.edu/index.php/vl/article/view/5765

* lisp/emacs-lisp/lisp-mode.el (emacs-lisp-docstring-fill-column):
* .dir-locals.el (fill-column, emacs-lisp-docstring-fill-column):
Bump default to 72.

(cherry picked from commit 72b1379f0795a5e2e9c57615c0b1d78c0b97cd1f)
.dir-locals.el
etc/NEWS
lisp/emacs-lisp/lisp-mode.el