branch: externals/org
commit d794a2307f202a5d1b0f8c00fd4734177b3db02d
Author: Slawomir Grochowski <[email protected]>
Commit: Slawomir Grochowski <[email protected]>
; org-colview: Clarify summary operator docstrings
* lisp/org-colview.el (org-columns--summary-type)
(org-columns--summarize-function, org-columns--collect-function): Clarify
docstrings.
---
lisp/org-colview.el | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/lisp/org-colview.el b/lisp/org-colview.el
index d2ecf33c1c..534c7f54e9 100644
--- a/lisp/org-colview.el
+++ b/lisp/org-colview.el
@@ -1386,17 +1386,18 @@ Return the result as a duration."
(error "Unknown %S operator" operator)))
(defun org-columns--summarize-function (operator)
- "Return summary function associated to string OPERATOR."
+ "Return summary function associated with OPERATOR.
+Return nil if OPERATOR is known but has no summerize function."
(pcase (org-columns--summary-type operator)
(`(,_ . ,(and (pred functionp) summarize-function)) summarize-function)
(`(,_ ,summarize-function ,_) summarize-function)
(_ (error "Invalid definition for operator %S" operator))))
(defun org-columns--collect-function (operator)
- "Return collect function associated to string OPERATOR.
-Return nil if no collect function is associated to OPERATOR."
+ "Return collect function associated with OPERATOR.
+Return nil if OPERATOR is known but has no collect function."
(pcase (org-columns--summary-type operator)
- (`(,_ . ,(pred functionp)) nil) ;default value
+ (`(,_ . ,(pred functionp)) nil)
(`(,_ ,_ ,collect-function) collect-function)
(_ (error "Invalid definition for operator %S" operator))))
