branch: externals-release/org
commit 0cf0f51163d363c255ef1370d102b7323650c1f5
Author: Xiaoduan Chang <[email protected]>
Commit: Ihor Radchenko <[email protected]>
lisp/org-archive.el: Update org-archive-subtree docstring
* lisp/org-archive.el (org-archive-subtree): Update docstring to
reflect that TODO state is only changed when `org-archive-mark-done'
is set to non-nil.
TINYCHANGE
---
lisp/org-archive.el | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/lisp/org-archive.el b/lisp/org-archive.el
index c66dc21682..102ac359fa 100644
--- a/lisp/org-archive.el
+++ b/lisp/org-archive.el
@@ -207,8 +207,9 @@ an error if LOCATION is not a valid archive location."
"Move the current subtree to the archive.
The archive can be a certain top-level heading in the current
file, or in a different file. The tree will be moved to that
-location, the subtree heading be marked DONE, and the current
-time will be added.
+location. If `org-archive-mark-done' is non-nil and the subtree
+has a TODO keyword, the subtree heading will be marked DONE.
+And the current time will be added.
When called with a single prefix argument FIND-DONE, find whole
trees without any open TODO items and archive them (after getting
