all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "João Távora" <joaotavora@gmail.com>
To: emacs-devel@gnu.org
Subject: docstring has wrong usage of unescaped single quotes (use \= or different quoting)
Date: Fri, 22 Jul 2022 11:24:01 +0100	[thread overview]
Message-ID: <87fsitphry.fsf@gmail.com> (raw)

Hi,

This byte-compilation warning pops up all over the place now.  I've
fixed it in some of my packages, but when byte-compiling I'm interested
in those warnings that, when unheeded, could cause my program logic to
produce incorrect results and/or waste resources.  Perhaps I'm mistaken,
but this does not seem like one such thing.  This is particularly noisy
when hunting problems with 'flymake-mode'.

Docstring checking code should go into "checkdoc", so one has a choice
of removing its checkdoc backend and the associated noise if one is not
interested in it.

Furthermore, in a tangent issue, I don't understand exactly the
suggestion in the warning message.  How exactly is \= to be used?  \='
doesn't work.  In one of my docstrings I had an elisp snippet for users
to copy-paste and I ended replacing the quote character with the 'quote'
special form, which works but now produces an inferior docstring.

Thanks,
João






             reply	other threads:[~2022-07-22 10:24 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-22 10:24 João Távora [this message]
2022-07-22 12:27 ` docstring has wrong usage of unescaped single quotes (use \= or different quoting) 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
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

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

  git send-email \
    --in-reply-to=87fsitphry.fsf@gmail.com \
    --to=joaotavora@gmail.com \
    --cc=emacs-devel@gnu.org \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.