branch: externals/org-remark
commit b595c74a060e43f85c2d940af131d95c6dbd133c
Author: Noboru Ota <m...@nobiot.com>
Commit: Noboru Ota <m...@nobiot.com>
doc: Update docstring for the sort fn
---
org-marginalia.el | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/org-marginalia.el b/org-marginalia.el
index 7c871da207..9aa76b81f1 100644
--- a/org-marginalia.el
+++ b/org-marginalia.el
@@ -502,7 +502,11 @@ If none, return nil."
(if reverse (reverse list) list)))))
(defun om/sort-highlights-list ()
- "Utility function to sort `om/sort-highlights'."
+ "Utility function to sort `om/sort-highlights'.
+It checks if there is any element exists for `om/highlights'.
+Instead of receiving it as an arg, it assumes its existence. It
+also distructively updates `om/highlights'.
+It returns t when sorting is done."
(when om/highlights
(setq om/highlights (seq-sort-by (lambda (s) (car (cdr s))) #'<
om/highlights))
t))
