all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* docstring has wrong usage of unescaped single quotes (use \= or different quoting)
@ 2022-07-22 10:24 João Távora
  2022-07-22 12:27 ` Phil Sainty
  2022-07-22 12:31 ` Antoine Kalmbach
  0 siblings, 2 replies; 7+ messages in thread
From: João Távora @ 2022-07-22 10:24 UTC (permalink / raw)
  To: emacs-devel

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






^ permalink raw reply	[flat|nested] 7+ messages in thread

end of thread, other threads:[~2022-07-22 20:08 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
2022-07-22 20:08         ` Lars Ingebrigtsen

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.