forked from mirrors/org-mode
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:
parent
a18ebc7893
commit
f159adc269
|
@ -523,8 +523,9 @@ properties, replacing their values in NODE."
|
||||||
(define-inline org-element-property (property node &optional dflt force-undefer)
|
(define-inline org-element-property (property node &optional dflt force-undefer)
|
||||||
"Extract the value from the PROPERTY of a NODE.
|
"Extract the value from the PROPERTY of a NODE.
|
||||||
Return DFLT when PROPERTY is not present.
|
Return DFLT when PROPERTY is not present.
|
||||||
When FORCE-UNDEFER is non-nil, unconditionally resolve deferred
|
When FORCE-UNDEFER is non-nil and the property value is computed
|
||||||
properties, replacing their values in NODE.
|
dynamically, unconditionally replace the dynamic deferred value,
|
||||||
|
modifying NODE by side effect.
|
||||||
|
|
||||||
Note: The properties listed in `org-element--standard-properties',
|
Note: The properties listed in `org-element--standard-properties',
|
||||||
except `:deferred', may not be resolved."
|
except `:deferred', may not be resolved."
|
||||||
|
|
Loading…
Reference in New Issue