]> git.eshelyaron.com Git - emacs.git/commit
checkdoc: Delete redundant check for wide docstrings
authorStefan Kangas <stefankangas@gmail.com>
Sun, 23 Mar 2025 16:22:51 +0000 (17:22 +0100)
committerEshel Yaron <me@eshelyaron.com>
Sun, 23 Mar 2025 19:34:42 +0000 (20:34 +0100)
commit2e3ae8d5d8ef841c17aa51415a1fb7b45c9a9056
tree476e1b19bd532e958fa47d2028b9644dcb35bae7
parent2432ad233d5d1bef16875b5a4b882a40f0a443d0
checkdoc: Delete redundant check for wide docstrings

With Emacs 28.1, wide docstrings are now flagged by the byte-compiler.
The logic in the byte-compiler for catching these issues is complex
and continuously evolving, particularly to avoid incorrectly flagging
`substitute-command-keys` substitutions.  Unfortunately, the checkdoc
implementation incorrectly flags correct docstrings as overly wide.

Rather than duplicating the byte-compiler logic in checkdoc, which
would introduce unnecessary maintenance overhead, we acknowledge that
this check is now redundant and remove it.  Users utilizing the
byte-compiler, whether manually or through `flymake`, will continue to
be warned about this issue.

* lisp/emacs-lisp/checkdoc.el (checkdoc-this-string-valid-engine):
Remove check for overly wide docstrings; duplicates byte-compiler
logic.

(cherry picked from commit 408ad273eeadf72dea11b89ea2a44f36ea0e2295)
lisp/emacs-lisp/checkdoc.el