mirrors
/
org-mode
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git
0
0
Fork 1
Code Releases Activity

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.
This commit is contained in:
Kyle Meyer 2017-07-18 13:31:07 -04:00
parent 8ed27480aa
commit 52e0966fd4
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
lisp/org.el
View File

@ -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