summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2024-04-04 16:28:31 +0300
committerEli Zaretskii <eliz@gnu.org>2024-04-04 16:28:31 +0300
commitc6899603b9c2e5de590ecfd6397a7125d1dab08b (patch)
treee5575e6594e31ccca95e70ca3268ac7a32369e82 /doc
parentbd2c4d825db69eeb592102edff9e3afb69c5a231 (diff)
downloademacs-c6899603b9c2e5de590ecfd6397a7125d1dab08b.tar.gz
; * doc/lispref/tips.texi (Documentation Tips): Improve (bug#70163).
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/tips.texi12
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index d538f416740..ae8b9c0c0ba 100644
--- a/doc/lispref/tips.texi
+++ b/doc/lispref/tips.texi
@@ -834,13 +834,15 @@ it substitutes whatever key is currently bound to @code{forward-char}.
user has moved key bindings.) @xref{Keys in Documentation}.
@item
-In documentation strings for a major mode, you will want to refer to the
-key bindings of that mode's local map, rather than global ones.
+In documentation strings for a major mode, you will want to refer to
+the key bindings of that mode's local map, rather than global ones.
Therefore, use the construct @samp{\\<@dots{}>} once in the
documentation string to specify which key map to use. Do this before
-the first use of @samp{\\[@dots{}]}. The text inside the
-@samp{\\<@dots{}>} should be the name of the variable containing the
-local keymap for the major mode.
+the first use of @samp{\\[@dots{}]}, and not in the middle of a
+sentence (since if the map is not loaded, the reference to the map
+will be replaced with a sentence saying the map is not currently
+defined). The text inside the @samp{\\<@dots{}>} should be the name
+of the variable containing the local keymap for the major mode.
Each use of @samp{\\[@dots{}]} slows the display of the documentation
string by a tiny amount. If you use a lot of them, these tiny