; Minor fixes in ELisp manual
authorEli Zaretskii <eliz@gnu.org>
Sat, 8 Jun 2024 18:06:51 +0000 (21:06 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sat, 8 Jun 2024 18:06:51 +0000 (21:06 +0300)
* doc/lispref/searching.texi (Regexp Search): Caveat about using
'search-spaces-regexp'.  (Bug#71429)
* doc/lispref/help.texi (Keys in Documentation): Fix markup.

doc/lispref/help.texi
doc/lispref/searching.texi

index f3c916a9ecc2af051189277299f40ad9f13145d7..dd51e32f8ade65d8d6c56d8e445c3f54e129478a 100644 (file)
@@ -334,6 +334,9 @@ stands for a key sequence that will invoke @var{command}, or @samp{M-x
 @item \@{@var{mapvar}@}
 stands for a summary of the keymap which is the value of the variable
 @var{mapvar}.  The summary is made using @code{describe-bindings}.
+The summary will normally exclude meny bindings, but if the
+@var{include-menus} argument to @code{substitute-command-keys} is
+non-@code{nil}, the menu bindings will be included.
 
 @item \<@var{mapvar}>
 stands for no text itself.  It is used only for a side effect: it
@@ -384,11 +387,6 @@ given a special face @code{help-key-binding}, but if the optional
 argument @var{no-face} is non-@code{nil}, the function doesn't add
 this face to the produced string.
 
-@defun substitute-quotes string
-This function works like @code{substitute-command-keys}, but only
-replaces quote characters.
-@end defun
-
 @cindex advertised binding
 If a command has multiple bindings, this function normally uses the
 first one it finds.  You can specify one particular key binding by
@@ -440,6 +438,11 @@ The keymap description will normally exclude menu items, but if
 @end group
 @end smallexample
 
+@defun substitute-quotes string
+This function works like @code{substitute-command-keys}, but only
+replaces quote characters.
+@end defun
+
   There are other special conventions for the text in documentation
 strings---for instance, you can refer to functions, variables, and
 sections of this manual.  @xref{Documentation Tips}, for details.
index c697c929b6a6cf84f213fefa75f600e01d16c25b..3022d127c13302278493ec6726933a6576b168de 100644 (file)
@@ -2190,7 +2190,11 @@ this regular expression.  However, spaces inside of constructs such as
 
 Since this variable affects all regular expression search and match
 constructs, you should bind it temporarily for as small as possible
-a part of the code.
+a part of the code, and only where the Lisp code affected by the
+binding performs searches whose regexp was produced from interactive
+user input.  In other words, this variable should only be used to tell
+regexp search primitives how to interpret whitespace typed by the
+user.
 @end defvar
 
 @node POSIX Regexps