Add docstring for dialog.open

cbui · Apr 29, 2019 · d4e4320 · d4e4320
1 parent 490f3a6
commit d4e4320
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/clj_slack/dialog.clj b/src/clj_slack/dialog.clj
@@ -2,5 +2,12 @@
   (:require [clj-slack.core :refer [slack-post-request]]))
 
 (defn open
+  "Opens a dialog for the user that caused the trigger trigger-id.
+
+  - dialog: a json encoded string of a dialog
+  - trigger-id: the trigger-id of the event that the dialog will open for
+
+  See: https://api.slack.com/methods/dialog.open
+  "
   [connection dialog trigger-id]
   (slack-post-request connection "dialog.open" {"dialog" dialog "trigger_id" trigger-id}))