emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: bytecomp: doc string wider than 80 spurious warnings are back


From: Eli Zaretskii
Subject: Re: bytecomp: doc string wider than 80 spurious warnings are back
Date: Fri, 29 Sep 2023 16:52:08 +0300

> From: "T.V Raman" <raman@google.com>
> Date: Wed, 27 Sep 2023 12:56:01 -0700
> 
> For docstring, since Emacs is the one that is going to display the
> docstring, I think code in the Help system should take care of
> formatting the  docstring to match the size of the window, not rely on
> the developer to  write the docstring to match  a hard-coded width.

This cannot be done reliably, since doc strings are not really free
text.  They have sections that must not be merged, the first line must
be distinct, there are subtleties with quoting and buttons, etc.

> The easiest thing for the help buffer to do might be to just turn on
> visual-line-mode

I don't want to do that for the above reasons, sorry.

> so yes, I think this warning is ill-adviced and noisy

We disagree.  This warning helped clean up many packages, both in and
outside of Emacs, so it is definitely useful.  If the warning is
caused by some macro package, it should be reported to the developers
of that macro package, and fixed by them.  But disregarding these
issues is a bad policy in the long run.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]