From 52e0966fd4c8b2890aaf8cc73ae68f9430a150e1 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Tue, 18 Jul 2017 13:31:07 -0400 Subject: [PATCH] Document STATE parameter for org-cycle-hide-* functions * lisp/org.el (org-cycle-hide-archived-subtrees): (org-cycle-hide-drawers): Mention STATE parameter in docstring. --- lisp/org.el | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lisp/org.el b/lisp/org.el index 1d1df7096..458ec6328 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -4852,7 +4852,9 @@ Otherwise, these types are allowed: :group 'org-sparse-trees) (defun org-cycle-hide-archived-subtrees (state) - "Re-hide all archived subtrees after a visibility state change." + "Re-hide all archived subtrees after a visibility state change. +STATE should be one of the symbols listed in the docstring of +`org-cycle-hook'." (when (and (not org-cycle-open-archived-trees) (not (memq state '(overview folded)))) (save-excursion @@ -7317,8 +7319,9 @@ open and agenda-wise Org files." (defun org-cycle-hide-drawers (state &optional exceptions) "Re-hide all drawers after a visibility state change. -When non-nil, optional argument EXCEPTIONS is a list of strings -specifying which drawers should not be hidden." +STATE should be one of the symbols listed in the docstring of +`org-cycle-hook'. When non-nil, optional argument EXCEPTIONS is +a list of strings specifying which drawers should not be hidden." (when (and (derived-mode-p 'org-mode) (not (memq state '(overview folded contents)))) (save-excursion