mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-24 07:20:37 +00:00
Code Issues Releases Activity

Improve documentation of 'isearch-open-overlay-temporary'

Browse Source 
* lisp/isearch.el (isearch-open-overlay-temporary): Document that
the overlay passed to the 'isearch-open-invisible-temporary'
function cannot be deleted too early.  (Bug#60399)
This commit is contained in:
Eli Zaretskii 2023-01-01 11:04:22 +02:00
parent ab3210e709
commit b394359261
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lisp/isearch.el
View File

@ -3723,8 +3723,14 @@ Optional third argument, if t, means if fail just return nil (no error).
(defun isearch-open-overlay-temporary (ov)
(if (not (null (overlay-get ov 'isearch-open-invisible-temporary)))
;; Some modes would want to open the overlays temporary during
;; isearch in their own way, they should set the
;; `isearch-open-invisible-temporary' to a function doing this.
;; isearch in their own way, they should set the overlay's
;; `isearch-open-invisible-temporary' property to a function
;; doing this.
;; Warning: if your code uses this technique, it should not
;; delete the overlay passed to that function, since the values
;; of the `invisible' property will be recorded on that overlay,
;; to be restored after isearch is done with the text hidden by
;; the overlay.
(funcall (overlay-get ov 'isearch-open-invisible-temporary) ov nil)
;; Store the values for the `invisible' property, and then set it to nil.
;; This way the text hidden by this overlay becomes visible.