]> git.eshelyaron.com Git - emacs.git/commitdiff
Documentation followup to a recent commit
authorEli Zaretskii <eliz@gnu.org>
Wed, 15 Sep 2021 19:01:21 +0000 (22:01 +0300)
committerEli Zaretskii <eliz@gnu.org>
Wed, 15 Sep 2021 19:01:21 +0000 (22:01 +0300)
* doc/lispref/tips.texi (Documentation Tips): Make the wording of
recommendation not to over-use \\[..] more future-proof.
(Bug#50599)

doc/lispref/tips.texi

index f0eb1079cafa14dd75e3af12819cb30ac18d3769..0b20c107bbaaa5fadcf1afaeb50ac7503ba1f640 100644 (file)
@@ -789,10 +789,12 @@ 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.
 
-It is not practical to use @samp{\\[@dots{}]} very many times, because
-display of the documentation string will become slow.  So use this to
-describe the most important commands in your major mode, and then use
-@samp{\\@{@dots{}@}} to display the rest of the mode's keymap.
+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
+slowdowns will add up, and might become tangible, especially on slow
+systems.  So our recommendation is not to over-use them; e.g., try to
+avoid using more than one reference to the same command in the same
+doc string.
 
 @item
 For consistency, phrase the verb in the first sentence of a function's