Update documentation for fire!

TheClimateCorporation · Jul 25, 2012 · 0fc1472 · 0fc1472
1 parent 0640595
commit 0fc1472
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/examples/sample-jobdef.clj b/examples/sample-jobdef.clj
@@ -329,9 +329,9 @@
 
 ; fire! returns right away. The jobflow-id is saved (context-get :jobflow-id).
 ; (fire! cluster steps)
-; steps is a list (in-line or collection) of steps to run.  OR steps is a "fn of eopts",
+; steps is a list (in-line or collection) of steps to run, or a "fn of eopts",
-; which returns a step or collection of steps.
+; which returns a step (created by defstep or a StepConfig object) or a collection of steps.
-; cluster is either a defcluster, or a fn that returns a single defcluster
+; cluster is defined by a previous defcluster, or a fn that returns a single cluster.
 (fire! sample-cluster sample-step)
 
 ; If you want to block on cluster startup, where <stage> is one of

diff --git a/src/main/clj/lemur/core.clj b/src/main/clj/lemur/core.clj
@@ -670,11 +670,11 @@ calls launch              - take action (upload files, start cluster, etc)
 (defn fire!
   "Based on the command, take action using the given cluster and steps.
 
-  [cluster steps*]
+  [(cluster|cluster-fn) (steps*|step-fn)]
-  or
-  [cluster steps-fn]
 
-  You can provide one or more steps, either as a collection or a variable length
+  The first arg is a cluster (created by defcluster) or a 'fn of eopts' that returns a cluster.
+
+  Scond arg is one or more steps, either as a collection or a variable length
   argument list.  Alternatively, you can provide a single 'fn of eopts' which returns
   a step or collection of steps. Each step is a defstep or a StepConfig.