about summary refs log tree commit diff
path: root/org-clubhouse.el
diff options
context:
space:
mode:
authorGriffin Smith <root@gws.fyi>2019-02-01T16·39-0500
committerGriffin Smith <root@gws.fyi>2019-02-01T16·39-0500
commitbaeff81f89f80751a8cb7257c750f3b4b1b8b36f (patch)
treef1c8947cc0e0e5bcbcf2a91f9f3d57787d8492ae /org-clubhouse.el
parent0967cbcea6de5dccf0d8512dafd0331e6c836bbe (diff)
docs: Bolster docs on setup, usage and config
Add docs for all config variables and interactive commands, and list
commands in the README
Diffstat (limited to 'org-clubhouse.el')
-rw-r--r--org-clubhouse.el10
1 files changed, 8 insertions, 2 deletions
diff --git a/org-clubhouse.el b/org-clubhouse.el
index 442e73edeb3a..456f372bd9eb 100644
--- a/org-clubhouse.el
+++ b/org-clubhouse.el
@@ -73,7 +73,10 @@ not be prompted")
     ("PR"     . "Review")
     ("DONE"   . "Merged")
     ("[X]"    . "Merged")
-    ("CLOSED" . "Merged")))
+    ("CLOSED" . "Merged"))
+  "Alist mapping org-mode todo keywords to their corresponding states in
+  Clubhouse. In `org-clubhouse-mode', moving headlines to these todo keywords
+  will update to the corresponding status in Clubhouse")
 
 (defvar org-clubhouse-story-types
   '(("feature" . "Feature")
@@ -86,7 +89,8 @@ not be prompted")
     ("chore"   . "Chore")
     ("prompt"  . "**Prompt each time (do not set a default story type)**")))
 
-(defvar org-clubhouse-default-state "Proposed")
+(defvar org-clubhouse-default-state "Proposed"
+  "Default state to create all new stories in")
 
 ;;;
 ;;; Utilities
@@ -693,6 +697,8 @@ allows manually passing a clubhouse ID and list of org-element plists to write"
 ;;;
 
 (defun org-clubhouse-update-story-title ()
+  "Updates the title of the Clubhouse story linked to the current headline with
+the text of the headline"
   (interactive)
 
   (when-let (clubhouse-id (org-element-clubhouse-id))