summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2022-06-04 13:29:53 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2022-06-04 13:29:53 +0200
commit01b192534af6a319b8c9b3e8730fd61bd8e74710 (patch)
treeed58d4c3f38215a1ff20dc89ea9040e5fa42caaf
parentf1b4c0aff507e32d0311e04c927b866dcb457ac3 (diff)
downloademacs-01b192534af6a319b8c9b3e8730fd61bd8e74710.tar.gz
emacs-01b192534af6a319b8c9b3e8730fd61bd8e74710.tar.bz2
emacs-01b192534af6a319b8c9b3e8730fd61bd8e74710.zip
Further notes about quotation marks in the manual
* doc/lispref/tips.texi (Documentation Tips): Note that we previously recommended using single quotation marks (bug#55780).
-rw-r--r--doc/lispref/tips.texi6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 82325502209..30146a89ebf 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -707,7 +707,11 @@ Note that when Emacs displays these doc strings, Emacs will usually
display @samp{`} (grave accent) as @samp{‘} (left single quotation
mark) and @samp{'} (apostrophe) as @samp{’} (right single quotation
mark), if the display supports displaying these characters.
-@xref{Keys in Documentation}.
+@xref{Keys in Documentation}. (Some previous versions of this section
+recommended using the non-@acronym{ASCII} single quotation marks
+directly in doc strings, but this is now discouraged, since that leads
+to broken help string displays on terminals that don't support
+displaying those characters.)
@cindex hyperlinks in documentation strings
Help mode automatically creates a hyperlink when a documentation string