Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ianj-als/pypeline.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIan Johnson <ian.johnson@appliedlanguage.com>2012-08-15 13:02:53 +0400
committerIan Johnson <ian.johnson@appliedlanguage.com>2012-08-15 13:02:53 +0400
commitf35d5d48cab08c22998ef4392b3cc1ee9193b200 (patch)
treed18dba7448d31293dc0551d1ec7c87c85ceae8d9 /README.md
parent9a805fa031cd40e3d128ccc12a0d0007bbca0869 (diff)
Tweek, and more readme stuff.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 5 insertions, 1 deletions
diff --git a/README.md b/README.md
index ae3d7e7..0be055a 100644
--- a/README.md
+++ b/README.md
@@ -117,12 +117,16 @@ The state mutator function shall take one argument and return a mutated state ob
helpers.cons_wire(schema_conv_function)
+Construct a wire based on a function. The function should take two arguments: the output from the function or output forming function, if specified, and the state object. The function should return the object that shall be passed to the next pipeline component.
+
#### Constructing a Dictionary Based Wire
helpers.cons_dictionary_wire(conversions)
+Construct a wire based on a *conversion* dictionary. Assuming that dictionaries are used as values passed through a pipeline, or pipeline component, a dictionary based wire can be used. The dictionary, whose keys are the keys in the previous component's output are mapped to the conversion dictionary's values that are the keys of the next stage input dictionary.
+
#### Wire Up Two Pipeline Components
helpers.wire_components(component_one, component_two, wire)
-
+Take two components and place a wire between them.