From 13f299fe8baf389374127572ee56a31910b36f2e Mon Sep 17 00:00:00 2001 From: Nicolas Goaziou Date: Tue, 18 Dec 2018 09:54:24 +0100 Subject: [PATCH] org-colview: Fix docstrings * lisp/org-colview.el (org-columns--overlay-text): (org-columns--summary-min-age): (org-columns--summary-max-age): (org-columns--summary-mean-age): Fix docstrings. --- lisp/org-colview.el | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/lisp/org-colview.el b/lisp/org-colview.el index 932275836..a2d482b2b 100644 --- a/lisp/org-colview.el +++ b/lisp/org-colview.el @@ -331,7 +331,11 @@ Return nil if no collect function is associated to OPERATOR." (_ (error "Invalid definition for operator %S" operator)))) (defun org-columns--overlay-text (value fmt width property original) - "Return text " + "Return decorated VALUE string for columns overlay display. +FMT is a format string. WIDTH is the width of the column, as an +integer. PROPERTY is the property being displayed, as a string. +ORIGINAL is the real string, i.e., before it is modified by +`org-columns--displayed-value'." (format fmt (let ((v (org-columns-add-ellipses value width))) (pcase property @@ -1289,17 +1293,17 @@ When PRINTF is non-nil, use it to format the result." times)) (defun org-columns--summary-min-age (ages _) - "Compute the minimum time among AGES." + "Compute the minimum age among AGES." (org-columns--format-age (apply #'min (mapcar #'org-columns--age-to-minutes ages)))) (defun org-columns--summary-max-age (ages _) - "Compute the maximum time among AGES." + "Compute the maximum age among AGES." (org-columns--format-age (apply #'max (mapcar #'org-columns--age-to-minutes ages)))) (defun org-columns--summary-mean-age (ages _) - "Compute the minimum time among AGES." + "Compute the mean age among AGES." (org-columns--format-age (/ (apply #'+ (mapcar #'org-columns--age-to-minutes ages)) (float (length ages)))))