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

Improve documentation of last change

Browse source 
* lisp/hi-lock.el (hi-lock-set-pattern, hi-lock-face-buffer):
Improve the doc strings.  (Bug#32365)

* etc/NEWS:
* doc/emacs/display.texi (Highlight Interactively): Clarify
wording.
This commit is contained in:
Eli Zaretskii 2018-08-15 05:37:45 +03:00
parent cc5a23d40b
commit bcdb2d9733
3 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
doc/emacs/display.texi
View file

@ -974,9 +974,10 @@ the buffer is loaded. For example, to highlight all occurrences of
the word ``whim'' using the default face (a yellow background), type
@kbd{M-s h r whim @key{RET} @key{RET}}. Any face can be used for
highlighting, Hi Lock provides several of its own and these are
pre-loaded into a list of default values. While being prompted
for a face use @kbd{M-n} and @kbd{M-p} to cycle through them. A prefix
argument limits the highlighting to the corresponding subexpression.
pre-loaded into a list of default values. While being prompted for a
face use @kbd{M-n} and @kbd{M-p} to cycle through them. A prefix
numeric argument limits the highlighting to the corresponding
subexpression.
@vindex hi-lock-auto-select-face
Setting the option @code{hi-lock-auto-select-face} to a non-@code{nil}

3
etc/NEWS
View file

@ -720,7 +720,8 @@ UUID at point.
+++
*** 'highlight-regexp' can now highlight subexpressions.
The command accepts a prefix argument to choose the subexpression.
The now command accepts a prefix numeric argument to choose the
subexpression.
* New Modes and Packages in Emacs 27.1

7
lisp/hi-lock.el
View file

@ -433,7 +433,8 @@ highlighting will not update as you type."
"Set face of each match of REGEXP to FACE.
Interactively, prompt for REGEXP using `read-regexp', then FACE.
Use the global history list for FACE. Limit face setting to the
corresponding SUBEXP of REGEXP.
corresponding SUBEXP (interactively, the prefix argument) of REGEXP.
If SUBEXP is omitted or nil, the entire REGEXP is highlighted.
Use Font lock mode, if enabled, to highlight REGEXP. Otherwise,
use overlays for highlighting. If overlays are used, the
@ -689,7 +690,9 @@ with completion and history."
(intern face)))
(defun hi-lock-set-pattern (regexp face &optional subexp)
"Highlight SUBEXP of REGEXP with face FACE."
"Highlight SUBEXP of REGEXP with face FACE.
If omitted or nil, SUBEXP defaults to zero, i.e. the entire
REGEXP is highlighted."
;; Hashcons the regexp, so it can be passed to remove-overlays later.
(setq regexp (hi-lock--hashcons regexp))
(setq subexp (or subexp 0))