lisp/org.el (org-skip-over-state-notes): Improve docstring

This commit is contained in:
Ihor Radchenko 2023-12-11 14:47:02 +01:00
parent 0c4358b4ac
commit 420ed4e033
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 5 additions and 1 deletions

View File

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