Skip to content

Commit 5ca8723

Browse files
committed
doc(arch): +endurance, linked from net-docs
1 parent 214ef7c commit 5ca8723

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

docs/source/arch.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,16 @@ Architecture
192192
A callable(op, node-data) that should return true for nodes not to be
193193
:meth:`~.NetworkOperation.narrowed`.
194194

195+
endurance
196+
Keep executing as many `operation`\s as possible, even of some of them fail.
197+
If :func:`.set_endure_execution()` is se to true, you may interogate
198+
:class:`.Solution` properties to discover whether an operation may be:
199+
200+
- executed successfully,
201+
- *failed*, or
202+
- *canceled*, if another operation, the sole provider of a compulsory `needs`,
203+
has failed upstreams.
204+
195205
.. default-role:: obj
196206
.. |v410-flowchart| raw:: html
197207
:file: images/GraphtikFlowchart-v4.1.0.svg

graphtik/network.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ def is_abort():
6363

6464

6565
def set_skip_evictions(skipped):
66-
"""If true, keep all intermediate solution values, regardless of asked outputs."""
66+
"""If :term:`eviction` is true, keep all intermediate solution values, regardless of asked outputs."""
6767
_execution_configs.get()["skip_evictions"] = bool(skipped)
6868

6969

@@ -73,7 +73,7 @@ def is_skip_evictions():
7373

7474

7575
def set_endure_execution(endure):
76-
"""If set to true, keep executing even of some operations fail."""
76+
"""If :term:`endurance` set to true, keep executing even of some operations fail."""
7777
_execution_configs.get()["endure_execution"] = bool(endure)
7878

7979

0 commit comments

Comments
 (0)