mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 18:40:39 -08:00
Code Issues Projects Releases Wiki Activity

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
Download patch file Download diff file Expand all files Collapse all files

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))