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 12:19:51 +0400
committerIan Johnson <ian.johnson@appliedlanguage.com>2012-08-15 12:19:51 +0400
commit3000a91d45e9e2e98354a773ba0d6bc2578625f1 (patch)
tree6ec4af57625084ea69a7e709c7f46a282123b5d7
parent6ba34ac3d739c27c3cc619cdcfea3c5d1f98badd (diff)
Update README.md
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 539a848..e948e25 100644
--- a/README.md
+++ b/README.md
@@ -97,6 +97,12 @@ The state mutator function shall take one argument and return a mutated state ob
output_forming_function,
state_mutator_function = None)
+Construct a pipeline component whose computation will be achieved using a sub-process. Input and output forming functions should generate the single line given to the `stdin` of the sub-process, and parse out the single line written to the sub-process' `stdout` respectively. An optional state mutator function can be provided to alter the state object passed into one of the pipeline run/evaluating/executing functions.
+
+The output from the previous is applied to the input forming function and the "stringyfied" resultant object is written to the sub-process' `stdin`. Once the sub-process has responded a single line, from `stdout`, is applied to the output formin function. This function is to parse the response and the resultant object is passed to the subsequent pipeline component, or wire. The input and output forming functions shall take one argument.
+
+The state mutator function shall take one argument and return a mutated state object if desired. If no state mutator function is specified the state flows through the component unchanged.
+
### Wire Functions
#### Constructing a Function Based Wire