[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#66264: Disable warning about wide doc strings by default
From: |
Mattias Engdegård |
Subject: |
bug#66264: Disable warning about wide doc strings by default |
Date: |
Fri, 29 Sep 2023 14:59:09 +0200 |
This is a proposal to disable the warning about doc string line length by
default.
While it is a useful warning, it does not actually indicate that anything may
be wrong in the code, nor that the doc string would risk being misinterpreted
by the user. It is rather a stylistic complaint, such as the ones produced by
checkdoc.
There have been complaints about the warning being difficult to avoid in code
where the doc string is generated by macros, sometimes outside the control of
the programmer. See
https://lists.gnu.org/archive/html/emacs-devel/2023-09/msg01326.html for one
such recent discussion.
For this reason I'm proposing that it be disabled by default but remain enabled
in builds of Emacs itself, like the warning about curved single quotes.
Patch attached.
docstrings-wide.diff
Description: Binary data
- bug#66264: Disable warning about wide doc strings by default,
Mattias Engdegård <=