Permalink
Browse files

docstring for 'compile'

  • Loading branch information...
1 parent e58dd86 commit 93c5273eb33014ea93c6ccdcfd595fc56a1e6624 @stuartsierra committed Oct 23, 2012
Showing with 5 additions and 4 deletions.
  1. +5 −4 src/com/stuartsierra/flow.clj
@@ -110,10 +110,11 @@
(defn compile
"Returns a function which executes the flow. The returned function
- will take a single argument, a map containing keywords which will be
- provided as input to the flow. Optional third argument is a
- collection of keywords desired in the output map; if not present
- defaults to all keys in the flow."
+ will take a single argument, a map from keywords to values. The
+ argument 'inputs' is the collection of keys which must be provided
+ in that map. Optional third argument is a collection of keywords
+ desired in the output map; if not present defaults to all keys in
+ the flow."
([flow inputs]
(compile flow inputs (keys flow)))
([flow inputs outputs]

0 comments on commit 93c5273

Please sign in to comment.