bug#60399: 30.0.50; Usage of `isearch-open-invisible-temporary' is not documented

[Ihor Radchenko <yantar92@posteo.net>]

Hi,

According to isearch.el source, one can use
`isearch-open-invisible-temporary' to implement custom hidden text
display during isearch. However, it is unclear what are the requirements
for that function.

From isearch source code, it appears that the function should accept two
arguments: overlays and a flag to open/close the overlay:

      ;; 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.
      (funcall  (overlay-get ov 'isearch-open-invisible-temporary)  ov nil)

However, it appears that deleting the passed overlay is, in fact,
prohibited. (manifested in
https://orgmode.org/list/87pmc4smdg.fsf@fastmail.fm)

Is there some detailed information about this feature available somewhere?

Best,
Ihor

In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
 3.24.35, cairo version 1.17.6) of 2022-12-26 built on localhost
Repository revision: cc29fab3a66c59e77d0ff67c0f3e2e34ec80a03c
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12101004
System Description: Gentoo Linux

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>