branch: externals/taxy
commit 5227980693d421618c3a15705bc57758f3829532
Author: Adam Porter <a...@alphapapa.net>
Commit: Adam Porter <a...@alphapapa.net>
Docs: (taxy-magit-section-define-column-definer) Add docstring
---
taxy-magit-section.el | 19 ++++++++++++++++---
1 file changed, 16 insertions(+), 3 deletions(-)
diff --git a/taxy-magit-section.el b/taxy-magit-section.el
index 62990d0..00dd217 100644
--- a/taxy-magit-section.el
+++ b/taxy-magit-section.el
@@ -180,10 +180,23 @@ Default visibility function for
;;;;; Macros
-;; TODO: Document this.
-
(cl-defmacro taxy-magit-section-define-column-definer (prefix &key
columns-variable-docstring)
- "FIXME: Docstring."
+ "Define a column-defining macro.
+The macro is named \"PREFIX-define-column\".
+
+These customization options are defined, which are to be used in
+a `taxy-magit-section' in its `:heading-indent' and
+`:item-indent' slots, respectively:
+
+ - PREFIX-level-indent
+ - PREFIX-item-indent
+
+As well as these variables, which are to be passed to
+`taxy-magit-section-format-items':
+
+ - PREFIX-columns
+ - PREFIX-column-formatters"
+ ;; TODO: Document this.
(let* ((definer-name (intern (format "%s-define-column" prefix)))
(definer-docstring (format "Define a column formatting function with
NAME.
NAME should be a string. BODY should return a string or nil. In
