From 6041817f426aa0976f557f4c108203b8eed37ac1 Mon Sep 17 00:00:00 2001 Message-Id: <6041817f426aa0976f557f4c108203b8eed37ac1.1651549348.git.yantar92@gmail.com> From: Ihor Radchenko Date: Tue, 3 May 2022 11:40:26 +0800 Subject: [PATCH] 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 | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/lisp/org-element.el b/lisp/org-element.el index 3856079aa..4be345001 100644 --- a/lisp/org-element.el +++ b/lisp/org-element.el @@ -4524,12 +4524,12 @@ (defun org-element-map (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 (e.g. 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 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. 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 +4557,7 @@ (defun org-element-map 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 -- 2.35.1