]> git.eshelyaron.com Git - emacs.git/commit
projects / emacs.git / commit
? search:
summary | shortlog | log | commit | commitdiff | tree
(parent: 6a1a628) | patch
Warn about docstrings with control characters
authorMattias Engdegård <mattiase@acm.org>
Fri, 23 Feb 2024 12:57:04 +0000 (13:57 +0100)
committerEshel Yaron <me@eshelyaron.com>
Wed, 28 Feb 2024 17:42:35 +0000 (18:42 +0100)
commit7f0af2513d68d85b4b6422d139a122696b99994c
tree00887375edc9510f3aaf2070248b8e70dd348176tree | snapshot
parent6a1a628b440e2efb56c7260c787634ae6cdaf857commit | diff
Warn about docstrings with control characters

It is easy to include control chars in doc strings by mistake, and the
result is often an unreadable mess.

* lisp/emacs-lisp/bytecomp.el (byte-compile-warning-types)
(byte-compile-warnings, byte-compile--docstring-style-warn):
Add `docstrings-control-chars` warning.
* etc/NEWS: Announce.

(cherry picked from commit 90d3b3408e404aba383302c3147d3ca614619986)
etc/NEWS diff | blob | history
lisp/emacs-lisp/bytecomp.el diff | blob | history
Unnamed repository; edit this file 'description' to name the repository.