diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 4 insertions, 4 deletions
@@ -114,16 +114,16 @@ The state mutator function shall take one argument, the state object, and return #### Constructing a Batch Subprocess Pipeline Component helpers.cons_batch_subprocess_component(process_pipe, - input_feed_function, + input_generator_function, output_function, state_mutator = None) -Construct a pipeline component whose computation requires many values to be sent to the sub-process. An input feed function is required that shall provide the values for the computation. This function shall be a generator that takes two arguments: the value, and the state. This function shall yield objects, that once "stringyfied", shall be sent, as one line, to the `stdin` of the sub-process. The `stdout` is ignored. +Construct a pipeline component whose computation requires many values to be sent to the sub-process. An input generator function is required that shall provide the values for the computation. This function shall be a generator that takes two arguments: the value, and the state. This function shall yield objects, that once "stringyfied", shall be sent, as one line, to the `stdin` of the sub-process. The `stdout` of the sub-process is ignored. -The output function generates the value that shall be passed to the subsequent pipeline component. +The output function generates the value that shall be passed to the subsequent pipeline component. This function shall take two arguments: the input value to the components, and the state object. input_feed_function :: a -> s -> b - output_function :: s -> c + output_function :: a -> s -> c The state mutator function shall take one argument, the state object, and return a mutated state of object if desired. If no state mutator function is specified the stat flows through the component unchanged. |