Skip to content

Commit 5635ae5

Browse files
committed
doc(arch) callbacks specs; match-inps/zip-outs
1 parent 3a51aef commit 5635ae5

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

docs/source/arch.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ Architecture
312312

313313
needs
314314
fn_needs
315+
matching inputs
315316
The list of `dependency` names an `operation` requires from `solution` as `inputs`,
316317

317318
roughly corresponding to underlying function's arguments (**fn_needs**).
@@ -325,6 +326,7 @@ Architecture
325326
provides
326327
user_provides
327328
fn_provides
329+
zipping outputs
328330
The list of `dependency` names an `operation` writes to the `solution` as `outputs`,
329331

330332
roughly corresponding to underlying function's results (**fn_provides**).
@@ -699,18 +701,22 @@ Architecture
699701
value. All of them default to ``None`` (false).
700702

701703
callbacks
702-
x2 user-defined callables that will be optionally called before & after each operation,
703-
installed on :meth:`.Pipeline.compute()`, which must have this signature::
704+
x2 user-defined optional callables called before & after each function,
705+
installed on :meth:`.Pipeline.compute()`, that they must have this signature::
704706

705707
callbacks(op_cb) -> None
706708

707-
... where ``op_cb`` is an instance of the :class:`.OpCb`
708-
:func:`~collections.namedtuple`.
709+
... where ``op_cb`` is an instance of the :class:`.OpCb` :func:`~collections.namedtuple`.
709710

710-
* A use case for the "pre" callback is to :ref:`set a breakpoint to specific operation
711-
<break_with_pre_callback>`.
712-
* A use case for the "post" callback is validate the solution and scream
713-
immediately on errors.
711+
pre-callback
712+
Called after :term:`marshalling` and before `matching inputs`.
713+
A use case would be to :ref:`a breakpoint triggered by some condition
714+
<break_with_pre_callback>`.
715+
716+
post-callback:
717+
Called after :term:`zipping outputs` and before :term:`marshalling` results
718+
back into `solution`.
719+
A use case would be to validate the solution and scream immediately on errors.
714720

715721
jetsam
716722
When a pipeline or an operation fails, the original exception gets annotated

0 commit comments

Comments
 (0)