ndwarshuis
/
org-mode
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

* lisp/org-cycle.el: Document all the function arguments 

(org-cycle-content):
(org-cycle-optimize-window-after-visibility-change):
(org-cycle-display-inline-images):
This commit is contained in:
Ihor Radchenko 2023-11-06 11:46:30 +02:00
parent 1014296344
commit 7056752f33
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
lisp/org-cycle.el
View File

@ -689,7 +689,7 @@ With a numeric prefix, show all headlines up to that level."
(defun org-cycle-content (&optional arg) (defun org-cycle-content (&optional arg)
"Show all headlines in the buffer, like a table of contents. "Show all headlines in the buffer, like a table of contents.
With numerical argument N, show content up to level N." With numerical argument ARG, show content up to level ARG."
(interactive "p") (interactive "p")
(org-fold-show-all '(headings)) (org-fold-show-all '(headings))
(save-excursion (save-excursion
@ -711,7 +711,9 @@ With numerical argument N, show content up to level N."
"Temporarily store scroll position to restore.") "Temporarily store scroll position to restore.")
(defun org-cycle-optimize-window-after-visibility-change (state) (defun org-cycle-optimize-window-after-visibility-change (state)
"Adjust the window after a change in outline visibility. "Adjust the window after a change in outline visibility.
This function is the default value of the hook `org-cycle-hook'." This function is the default value of the hook `org-cycle-hook'.
STATE is the current outline visibility state. It should be one of
symbols `content', `all', `folded', `children', or `subtree'."
(when (get-buffer-window (current-buffer)) (when (get-buffer-window (current-buffer))
(let ((repeat (eq last-command this-command))) (let ((repeat (eq last-command this-command)))
(unless repeat (unless repeat
@ -797,7 +799,9 @@ STATE should be one of the symbols listed in the docstring of
(defun org-cycle-display-inline-images (state) (defun org-cycle-display-inline-images (state)
"Auto display inline images under subtree when cycling. "Auto display inline images under subtree when cycling.
It works when `org-cycle-inline-images-display' is non-nil." It works when `org-cycle-inline-images-display' is non-nil.
STATE is the current outline visibility state. It should be one of
symbols `content', `all', `folded', `children', or `subtree'."
(when org-cycle-inline-images-display (when org-cycle-inline-images-display
(pcase state (pcase state
('children ('children