diff options
author | Eli Zaretskii <eliz@gnu.org> | 2024-04-06 11:13:35 -0400 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2024-04-06 11:13:35 -0400 |
commit | b4864ca4affe6527b5958214ef2aa7198eb09220 (patch) | |
tree | 49cc99001cd2cc3bff6223ee0eabbf1f27091f61 /doc | |
parent | 7aea688ee93cc9ce9f8a8bdd5837414bcf250c37 (diff) | |
parent | 3d87d74a23d13e853f202cc589eb750c40f9e2be (diff) | |
download | emacs-b4864ca4affe6527b5958214ef2aa7198eb09220.tar.gz |
Merge from origin/emacs-29
3d87d74a23d ; * etc/PROBLEMS: Entry about slow mouse-wheel with GTK3 ...
c6899603b9c ; * doc/lispref/tips.texi (Documentation Tips): Improve (...
bd2c4d825db ; Update admin/make-tarball.txt
f107dc26e37 ; * etc/PROBLEMS: Add an entry about WebKitGTK (bug#66068).
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lispref/tips.texi | 12 |
1 files changed, 7 insertions, 5 deletions
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 |