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

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

[elpa] externals/org f159adc269 1/2: org-element-property: Improve docst


From: ELPA Syncer
Subject: [elpa] externals/org f159adc269 1/2: org-element-property: Improve docstring
Date: Wed, 9 Aug 2023 03:58:30 -0400 (EDT)

branch: externals/org
commit f159adc2690717a3b89878a2023319aae4c5c34c
Author: Ihor Radchenko <yantar92@posteo.net>
Commit: Ihor Radchenko <yantar92@posteo.net>

    org-element-property: Improve docstring
    
    * lisp/org-element-ast.el (org-element-property): Clarify the meaning
    of FORCE-UNDEFER argument.
---
 lisp/org-element-ast.el | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/lisp/org-element-ast.el b/lisp/org-element-ast.el
index 70177d5068..c845be26b4 100644
--- a/lisp/org-element-ast.el
+++ b/lisp/org-element-ast.el
@@ -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."



reply via email to

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