[Top][All Lists]

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

Re: docstring has wrong usage of unescaped single quotes (use \= or diff

From: Lars Ingebrigtsen
Subject: Re: docstring has wrong usage of unescaped single quotes (use \= or different quoting)
Date: Fri, 22 Jul 2022 16:38:05 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux)

João Távora <joaotavora@gmail.com> writes:

> But, IMHO, introducing such a new warning that has little to do with
> byte-compilation is a drag on people working with existing packages and
> looking for byte-compilation issues.

We've been using byte compilation warnings for ages to make people
actually fix things that aren't, strictly speaking, necessary for
getting something to byte compile.  For instance, deprecation warnings
and warnings about not using save-excursion+set-buffer.  These new
warnings are about more "real" problems than those two, in a way,
because they indicate that the markup used in the doc string is
incorrect, and people trying to use code examples from the doc string
will fail (for instance, when a (setq bar 'foo) is rendered as
(setq bar ’foo) in the *Help* buffer.

> Maybe there is a flag to turn off
> or demote this warning, and maybe that flag could be used in
> elisp-flymake-byte-compile.

See `byte-compile-warning-types'.

(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

reply via email to

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