procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Shorten docstrings generated by cl-defsubst

Browse source 
* lisp/emacs-lisp/cl-macs.el (cl-defsubst): Split the first line of
the docstring into 2 lines if the function name is very long.
Additionally, remove the word "inlining" in the generated docstring as
it is not very useful and increases the likelihood of "docstring wider
than 80 characters" errors.  (Bug#65790)
This commit is contained in:
Damien Cassou 2023-09-12 08:28:37 +02:00 • committed by Stefan Kangas
parent d436c559a4
commit f045750fa5
2 changed files with 19 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
lisp/emacs-lisp/cl-macs.el
View file

@ -2931,7 +2931,14 @@ The function's arguments should be treated as immutable.
,(if (memq '&key args)
`(&whole cl-whole &cl-quote ,@args)
(cons '&cl-quote args))
,(format "compiler-macro for inlining `%s'." name)
;; NB. This will produce incorrect results in some
;; cases, as our coding conventions says that the first
;; line must be a full sentence. However, if we don't
;; word wrap we will have byte-compiler warnings about
;; overly long docstrings. So we can't have a perfect
;; result here, and choose to avoid the byte-compiler
;; warnings.
,(internal--format-docstring-line "compiler-macro for `%s'." name)
(cl--defsubst-expand
',argns '(cl-block ,name ,@(cdr (macroexp-parse-body body)))
nil

11
test/lisp/emacs-lisp/bytecomp-tests.el
View file

@ -972,6 +972,17 @@ byte-compiled. Run with dynamic binding."
(bytecomp--with-warning-test "defvar.*foo.*wider than.*characters"
`(defvar foo t ,bytecomp-tests--docstring)))
(ert-deftest bytecomp-warn-wide-docstring/cl-defsubst ()
(bytecomp--without-warning-test
`(cl-defsubst short-name ()
"Do something."))
(bytecomp--without-warning-test
`(cl-defsubst long-name-with-less-80-characters-but-still-quite-a-bit ()
"Do something."))
(bytecomp--with-warning-test "wider than.*characters"
`(cl-defsubst long-name-with-more-than-80-characters-yes-this-is-a-very-long-name-but-why-not!! ()
"Do something.")))
(ert-deftest bytecomp-warn-quoted-condition ()
(bytecomp--with-warning-test
"Warning: `condition-case' condition should not be quoted: 'arith-error"