tec/org-mode
tec
/
org-mode
forked from mirrors/org-mode
1
0
Fork 0
Code Pull Requests Releases Activity

org-element-property: Improve docstring 

* lisp/org-element-ast.el (org-element-property): Clarify the meaning
of FORCE-UNDEFER argument.
This commit is contained in:
Ihor Radchenko 2023-08-09 10:26:11 +03:00
parent a18ebc7893
commit f159adc269
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
lisp/org-element-ast.el
View File

@ -523,8 +523,9 @@ properties, replacing their values in NODE."
(define-inline org-element-property (property node &optional dflt force-undefer)
"Extract the value from the PROPERTY of a NODE.
Return DFLT when PROPERTY is not present.
When FORCE-UNDEFER is non-nil, unconditionally resolve deferred
properties, replacing their values in NODE.
When FORCE-UNDEFER is non-nil and the property value is computed
dynamically, unconditionally replace the dynamic deferred value,
modifying NODE by side effect.
Note: The properties listed in `org-element--standard-properties',
except `:deferred', may not be resolved."