From 791efaf24cb034d787c587f2ff349ae96a288a92 Mon Sep 17 00:00:00 2001 From: Luke Kenneth Casson Leighton Date: Sat, 27 Apr 2019 23:38:37 +0100 Subject: [PATCH] update docstrings / comments --- src/add/iocontrol.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/add/iocontrol.py b/src/add/iocontrol.py index 02e24780..a4450c80 100644 --- a/src/add/iocontrol.py +++ b/src/add/iocontrol.py @@ -9,6 +9,14 @@ stage requires compliance with a strict API that may be implemented in several means, including as a static class. + + Stage Blocks really must be combinatorial blocks. It would be ok + to have input come in from sync'd sources (clock-driven) however by + doing so they would no longer be deterministic, and chaining such + blocks with such side-effects together could result in unexpected, + unpredictable, unreproduceable behaviour. + So generally to be avoided, then unless you know what you are doing. + the methods of a stage instance must be as follows: * ispec() - Input data format specification -- 2.30.2