emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/org 3996ea99a3 1/2: org-element-map: Refer to `org-elem


From: ELPA Syncer
Subject: [elpa] externals/org 3996ea99a3 1/2: org-element-map: Refer to `org-element-parse-buffer' in the docstring
Date: Sat, 14 May 2022 01:57:43 -0400 (EDT)

branch: externals/org
commit 3996ea99a37c05047a08903ede7ba9ec0cf2db18
Author: Ihor Radchenko <yantar92@gmail.com>
Commit: Ihor Radchenko <yantar92@gmail.com>

    org-element-map: Refer to `org-element-parse-buffer' in the docstring
    
    * lisp/org-element.el (org-element-map): Update docstring.  Mention
    that parse tree can be obtained using `org-element-parse-buffer'.  Add
    an example.
---
 lisp/org-element.el | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/lisp/org-element.el b/lisp/org-element.el
index 3856079aae..6a5cfea1a4 100644
--- a/lisp/org-element.el
+++ b/lisp/org-element.el
@@ -4524,12 +4524,13 @@ If STRING is the empty string or nil, return nil."
     (data types fun &optional info first-match no-recursion with-affiliated)
   "Map a function on selected elements or objects.
 
-DATA is a parse tree, an element, an object, a string, or a list
-of such constructs.  TYPES is a symbol or list of symbols of
-elements or objects types (see `org-element-all-elements' and
-`org-element-all-objects' for a complete list of types).  FUN is
-the function called on the matching element or object.  It has to
-accept one argument: the element or object itself.
+DATA is a parse tree (for example, returned by
+`org-element-parse-buffer'), an element, an object, a string, or a
+list of such constructs.  TYPES is a symbol or list of symbols of
+elements or object types (see `org-element-all-elements' and
+`org-element-all-objects' for a complete list of types).  FUN is the
+function called on the matching element or object.  It has to accept
+one argument: the element or object itself.
 
 When optional argument INFO is non-nil, it should be a plist
 holding export options.  In that case, parts of the parse tree
@@ -4557,6 +4558,7 @@ Assuming TREE is a variable containing an Org buffer 
parse tree,
 the following example will return a flat list of all `src-block'
 and `example-block' elements in it:
 
+  (setq tree (org-element-parse-buffer))
   (org-element-map tree \\='(example-block src-block) #\\='identity)
 
 The following snippet will find the first headline with a level



reply via email to

[Prev in Thread] Current Thread [Next in Thread]