Skip to content

Commit 019db7e

Browse files
committed
doc(terms): cross-ref alias, endure/resched with tutorial
1 parent 4078dd4 commit 019db7e

File tree

3 files changed

+12
-2
lines changed

3 files changed

+12
-2
lines changed

docs/source/arch.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Architecture
255255
alias
256256
Map an existing name in `fn_provides` into a duplicate, artificial one in `op_provides` .
257257

258-
You cannot alias an *alias*.
258+
You cannot alias an *alias*. See :ref:`aliases`
259259

260260
returns dictionary
261261
When an `operation` is marked with this flag, the underlying function is not
@@ -330,6 +330,8 @@ Architecture
330330
i.e. they cannot control which of their sideffects they have produced,
331331
it's either all or nothing.
332332

333+
See :ref:`rescheduled`
334+
333335
endurance
334336
endured
335337
Keep executing as many `operation`\s as possible, even if some of them fail.
@@ -341,6 +343,8 @@ Architecture
341343
of each executed operations or call one of :meth:`.check_if_incomplete()`
342344
or :meth:`.scream_if_incomplete()`.
343345

346+
See :ref:`endured`
347+
344348
predicate
345349
node predicate
346350
A callable(op, node-data) that should return true for nodes to be

docs/source/composition.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,8 @@ As always, we can run computations with this graph by simply calling it:
207207

208208
Advanced pipelines
209209
------------------
210+
.. _endured:
211+
210212
Resilience on errors (*endured*)
211213
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
212214
It is possible for pipeline persist executing operations, even if some of them
@@ -259,6 +261,8 @@ You may then optionally abort on failures, by raising an appropriate exception:
259261
+--get_out: ValueError('Quarantined!')
260262

261263

264+
.. _rescheduled:
265+
262266
Operations with partial outputs (*rescheduled*)
263267
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
264268
In case the actually produce `outputs` depend on some condition in the `inputs`,

docs/source/operations.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,14 @@ squares/houses are *data*):
9696
See :ref:`plotting` on how to make diagrams like this.
9797

9898

99+
.. _aliases:
100+
99101
Aliased `provides`
100102
^^^^^^^^^^^^^^^^^^
101103
Sometimes, you need to interface operations where they name some :term:`dependency`
102104
differently.
103105
This is doable without introducing "pipe-through" interface operation, either by
104-
annotating `needs` with :class:`.kw` `modifiers` (see docs) or with *aliases*
106+
annotating `needs` with :class:`.kw` `modifiers` (see docs) or with :term:`alias`\es
105107
on the `provides` side:
106108

107109
>>> op = operation(str,

0 commit comments

Comments
 (0)