From 0fc147278f3cf47e629885fef965f2fc5b1577a1 Mon Sep 17 00:00:00 2001 From: Marc Limotte Date: Tue, 24 Jul 2012 23:44:54 -0400 Subject: [PATCH] Update documentation for fire! --- examples/sample-jobdef.clj | 6 +++--- src/main/clj/lemur/core.clj | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/examples/sample-jobdef.clj b/examples/sample-jobdef.clj index 6afd59e..1a422a4 100644 --- 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", -; which returns a step or collection of steps. -; cluster is either a defcluster, or a fn that returns a single defcluster +; steps is a list (in-line or collection) of steps to run, or a "fn of eopts", +; which returns a step (created by defstep or a StepConfig object) or a collection of steps. +; 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 is one of diff --git a/src/main/clj/lemur/core.clj b/src/main/clj/lemur/core.clj index 5ee51e0..4de971c 100644 --- 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*] - or - [cluster steps-fn] + [(cluster|cluster-fn) (steps*|step-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.