mirrors
/
org-mode
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git
0
0
Fork 1
Code Releases Activity

org-element-cache-map: Update docstring

This commit is contained in:
Ihor Radchenko 2021-11-24 15:46:12 +08:00
parent cc3b468657
commit e76c29a586
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
lisp/org-element.el
View File

@ -7025,13 +7025,18 @@ buffers."
"Map all elements in current buffer with FUNC according to
GRANULARITY. Collect non-nil return values into result list.
FUNC should accept a single argument - the element.
FUNC can safely modify the buffer, but doing so may reduce
performance.
If some elements are not yet in cache, they will be added.
GRANULARITY can be `headline', `headline+inlinetask'
`greater-element', or `element'. The default is
`headline+inlinetask'. `object' granularity is not supported.
ELEMENTS is a list of elements to be mapped over.
RESTRICT-ELEMENTS is a list of element types to be mapped over.
NEXT-RE is a regexp used to search next candidate match when FUNC
returns non-nil and to search the first candidate match. FAIL-RE is a
@ -7052,9 +7057,10 @@ returns non-nil.
NARROW controls whether current buffer narrowing should be preserved.
This function is a subset of what `org-element-map' does, but much
more performant. Cached elements are supplied as the single argument
of FUNC. Changes to elements made in FUNC will also alter the cache."
This function does a subset of what `org-element-map' does, but with
much better performance. Cached elements are supplied as the single
argument of FUNC. Changes to elements made in FUNC will also alter
the cache."
(unless (org-element--cache-active-p)
(error "Cache must be active."))
(unless (memq granularity '( headline headline+inlinetask