From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 4 Apr 2024 13:28:31 +0000 (+0300)
Subject: ; * doc/lispref/tips.texi (Documentation Tips): Improve (bug#70163).
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=0216fe57dd7a9ad3a4d9ea4442e78c88a227ed8a;p=emacs.git

; * doc/lispref/tips.texi (Documentation Tips): Improve (bug#70163).

(cherry picked from commit c6899603b9c2e5de590ecfd6397a7125d1dab08b)
---

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi
index 0db9a35ac6f..1e35b82e413 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