Attempt to simplify the docs with less abstract wording #12
Conversation
| available to downstream functions via :py:mod:`dependency_injection`. Now | ||
| Each function returns a :py:class:`dict`, which updates the state of | ||
| the current run of the algorithm. Parameters for every function are | ||
| automatically fetched from `state` dictionary, using their names as |
|
@whit537, okay, take a look. |
|
@whit537 ping. |
| exception handling. | ||
| The algorithm in this module is a list of functions that are | ||
| executed in defined order, the return values of which update the | ||
| algorithm's run state in a `state` dictionary. |
There was a problem hiding this comment.
Why didn't you use what I suggested at #12 (comment)?
The model presented in this module is a list of functions that are executed in defined order, the return values of which update the algorithm's run state in a state dictionary.
There was a problem hiding this comment.
Because The model is too abstract. I tried to make text less academic, because the module provides a fixed algorithm - no need to say model of algorithm. Perhaps a better wording would be "The module provides a fixed algorithm defined as a list of functions that are executed in sequential order. The return value from each function updates state of algorithm stored in state dictionary.".
|
Closing as obsolete. |
No description provided.