[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#65790: 29.1; "docstring wider than 80 characters" when there is no d
From: |
Damien Cassou |
Subject: |
bug#65790: 29.1; "docstring wider than 80 characters" when there is no docstring |
Date: |
Tue, 12 Sep 2023 21:22:26 +0200 |
Thank you for your feedback. 3 patch files are attached to this
email. My answers below:
Stefan Kangas <stefankangas@gmail.com> writes:
> Damien Cassou <damien@cassou.me> writes:
> I think this also could use some tests, see bytecomp-tests.el:964 and
> onwards.
I've added tests to bytecomp-tests.el as suggested. (why not
cl-macs-tests.el instead?)
>> * lisp/emacs-lisp/cl-macs.el (cl-defsubst): Reduce likelihood of
>> "docstring wider than 80 characters" errors in generated code.
>
> Please remember to include the bug number when it is known.
done
>> - ,(format "compiler-macro for inlining `%s'." name)
>> […]
>> + ,(internal--format-docstring-line "compiler-macro for `%s'."
>> name)
>
> Why drop the word "inlining"?
I felt this word was not really important because (1) this is generated
code and (2) the docstring starts with "compiler-macro". Removing it
reduces the likelihood of the error message. I added an explanation in
the commit message. If the word is important I can add it back.
> (This comment might need reflowing.)
done
> Could we keep the old format when possible, and use the new one only
> when needed?
I tried to do that, is that what you want? I feel the added complexity
isn't worth it so I'm fine changing it back to the simpler version if
you change your mind.
--
Damien Cassou
"Success is the ability to go from one failure to another without
losing enthusiasm." --Winston Churchill
0001-bytecomp-tests.el-Add-new-helper-function.patch
Description: Text Data
0002-Shorten-docstrings-generated-by-cl-defsubst-bug-6579.patch
Description: Text Data
0003-Shorten-docstrings-generated-by-cl-defstruct-bug-657.patch
Description: Text Data