branch: externals/org
commit 420ed4e0338d12e26c62d3666ca39e7cff323d05
Author: Ihor Radchenko <[email protected]>
Commit: Ihor Radchenko <[email protected]>
lisp/org.el (org-skip-over-state-notes): Improve docstring
---
lisp/org.el | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/lisp/org.el b/lisp/org.el
index 8dc297b796..695721997e 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -10563,7 +10563,11 @@ EXTRA is additional text that will be inserted into
the notes buffer."
(add-hook 'post-command-hook 'org-add-log-note 'append))
(defun org-skip-over-state-notes ()
- "Skip past the list of State notes in an entry."
+ "Skip past the list of State notes in an entry.
+The point is assumed to be on a list of State notes, each matching
+`org-log-note-headings'. The function moves point to the first list
+item that is not a State note or to the end of the list if all the
+items are State notes."
(when (ignore-errors (goto-char (org-in-item-p)))
(let* ((struct (org-list-struct))
(prevs (org-list-prevs-alist struct))
