explain-pause-mode
explain-pause-mode copied to clipboard
installation fails in Emacs 28.2 due to the long docstrings
When I try to install the package using make
I am getting errors about the docstrings being too long:
Compiling file /home/me/emacs.d/el-get/explain-pause-mode/explain-pause-mode.el at Thu Apr 13 15:09:24 2023
In explain-pause-top--table-generate-offsets:
explain-pause-mode.el:694:8: Warning: docstring wider than 80 characters
In explain-pause-top--command-entry-column-fields-compare:
explain-pause-mode.el:1428:11: Warning: docstring wider than 80 characters
explain-pause-mode.el:1735:12: Warning: docstring wider than 80 characters
explain-pause-mode.el:1808:1: Warning: custom-declare-variable
`explain-pause-alert-style' docstring wider than 80 characters
In explain-pause--check-not-top-level:
explain-pause-mode.el:2484:11: Warning: docstring wider than 80 characters
It is strange because on those lines there is no docstrings.
Interestingly, the errors are on lines that call cl-defstruct
macros, so I believe it has something to do with the macro expansion; when I reduce the length of the macros, the errors disappear.
Possible solutions:
- disable treating warnings as errors in
Makefile
: inbyte-compile
target, change(setq byte-compile-error-on-warn t)
to(setq byte-compile-error-on-warn nil)
- make the names of the macros shorter
...alternatively, the limit can be extended by modifying the byte-compile-docstring-max-column