unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "João Távora" <joaotavora@gmail.com>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: Antoine Kalmbach <ane@iki.fi>,
	 Phil Sainty <psainty@orcon.net.nz>,
	emacs-devel@gnu.org
Subject: Re: docstring has wrong usage of unescaped single quotes (use \= or different quoting)
Date: Fri, 22 Jul 2022 16:23:48 +0100	[thread overview]
Message-ID: <87a691npbv.fsf@gmail.com> (raw)
In-Reply-To: <87o7xh8b76.fsf@gnus.org> (Lars Ingebrigtsen's message of "Fri, 22 Jul 2022 16:38:05 +0200")

Lars Ingebrigtsen <larsi@gnus.org> writes:

> 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.

Presumably these warnings tell me something about the
forward-compatiblity, performance, or otherwise functional aspects of my
program.  I do not count the documentation there.  It's not that I don't
pay attention to it, but I don't necessarily do simultaneously when
making my program functionally correct.  This is why we one has
different checkers, and why different checkers check different things.

In the byte-compilation check, this is a hack.  Else we may just as well
add spell-checking to the byte-compiler.

>> 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'.

Thanks.

João




  reply	other threads:[~2022-07-22 15:23 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-22 10:24 docstring has wrong usage of unescaped single quotes (use \= or different quoting) João Távora
2022-07-22 12:27 ` Phil Sainty
2022-07-22 12:31 ` Antoine Kalmbach
2022-07-22 14:12   ` João Távora
2022-07-22 14:38     ` Lars Ingebrigtsen
2022-07-22 15:23       ` João Távora [this message]
2022-07-22 20:08         ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87a691npbv.fsf@gmail.com \
    --to=joaotavora@gmail.com \
    --cc=ane@iki.fi \
    --cc=emacs-devel@gnu.org \
    --cc=larsi@gnus.org \
    --cc=psainty@orcon.net.nz \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).