diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2018-08-15 05:37:45 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2018-08-15 05:37:45 +0300 |
| commit | bcdb2d9733118a6529a66e12c3f2dc7662370c15 (patch) | |
| tree | bc1c7fbaa0a2416122de31bf0787e6022bbef6e8 /lisp/hi-lock.el | |
| parent | cc5a23d40bfa7a832f7a6fb7a016557ac1416559 (diff) | |
| download | emacs-bcdb2d9733118a6529a66e12c3f2dc7662370c15.tar.gz emacs-bcdb2d9733118a6529a66e12c3f2dc7662370c15.tar.bz2 emacs-bcdb2d9733118a6529a66e12c3f2dc7662370c15.zip | |
Improve documentation of last change
* 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.
Diffstat (limited to 'lisp/hi-lock.el')
| -rw-r--r-- | lisp/hi-lock.el | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/lisp/hi-lock.el b/lisp/hi-lock.el index 23820cda587..08b58117dd0 100644 --- a/lisp/hi-lock.el +++ b/lisp/hi-lock.el @@ -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)) |