branch: externals/org
commit ea546ccb48787bed8f51dcc00c813561d1810f6b
Author: Slawomir Grochowski <[email protected]>
Commit: Slawomir Grochowski <[email protected]>
; org-colview: Clarify overlay text docstring
* lisp/org-colview.el (org-columns--overlay-text): Clarify how
PROPERTY is used.
No behavior change.
---
lisp/org-colview.el | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/lisp/org-colview.el b/lisp/org-colview.el
index 2c2695b6f0..da1e55af93 100644
--- a/lisp/org-colview.el
+++ b/lisp/org-colview.el
@@ -415,9 +415,9 @@ further column follows."
(displayed-value cell-format-string width property value)
"Return decorated DISPLAYED-VALUE string for column overlay display.
CELL-FORMAT-STRING is a `format' string. WIDTH is the width of the
-column, as an integer. PROPERTY is the property being displayed,
-as a string. VALUE is the raw property value before it is modified
-by `org-columns--displayed-value'."
+column, as an integer. PROPERTY identifies the column and is used
+to select faces for the displayed cell text. VALUE is the raw
+property value before it is modified by `org-columns--displayed-value'."
(format cell-format-string
(let ((cell-text (org-columns-add-ellipses displayed-value width)))
(pcase property
