summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIhor Radchenko <yantar92@posteo.net>2023-12-11 14:47:02 +0100
committerIhor Radchenko <yantar92@posteo.net>2023-12-11 14:47:02 +0100
commit420ed4e0338d12e26c62d3666ca39e7cff323d05 (patch)
treecdba8a596ecf1b877b1aa25b1f7435d1ddf95e78
parent0c4358b4acde2f08d9eb52e07a6b74dc9bac519f (diff)
downloadorg-mode-420ed4e03.tar.gz
lisp/org.el (org-skip-over-state-notes): Improve docstring
-rw-r--r--lisp/org.el6
1 files changed, 5 insertions, 1 deletions
diff --git a/lisp/org.el b/lisp/org.el
index 8dc297b..6957219 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))