procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Minor fixes in ELisp manual

Browse source 
* doc/lispref/searching.texi (Regexp Search): Caveat about using
'search-spaces-regexp'.  (Bug#71429)
* doc/lispref/help.texi (Keys in Documentation): Fix markup.
This commit is contained in:
Eli Zaretskii 2024-06-08 21:06:51 +03:00
parent 53e9caa23e
commit e6044b29e6
2 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/lispref/help.texi
View 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.

6
doc/lispref/searching.texi
View 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