Small error in the documentation

[poldpold]

Describe the bug
In the introduction section of the documentation, under the heading Anatomy of a csp.node the code does not run. We get a python error instead.

To Reproduce
Go to https://github.com/Point72/csp/wiki/0.-Introduction, copy the example code, add from datetime import timedelta and run it:

from datetime import timedelta

@csp.node                                                                # 1
def demo_node(n: int, xs: ts[float], ys: ts[float]) -> ts[float]:        # 2
    with csp.alarms():                                                   # 3
        # Define an alarm time-series of type bool                       # 4
        alarm = csp.alarm(bool)                                          # 5 
                                                                         # 6
    with csp.state():                                                    # 7
        # Create a state variable bound to the node                      # 8
        s_sum = 0.0                                                      # 9
                                                                         # 10
    with csp.start():                                                    # 11
        # Code block that executes once on start of the engine           # 12
        # one can set timeseries properties here as well, such as        # 13
        # csp.set_buffering_policy(xs, tick_count=5)                     # 14
        # csp.set_buffering_policy(xs, tick_history=timedelta(minutes=1))# 15
        # csp.make_passive(xs)                                           # 16
        csp.schedule_alarm(alarm, timedelta(seconds=1), True)            # 17
                                                                         # 18
    with csp.stop():                                                     # 19
        # code block to execute when the engine is done                  # 20
                                                                         # 21
    if csp.ticked(xs, ys) and csp.valid(xs, ys):                         # 22
        s_sum += xs * ys                                                 # 23
                                                                         # 24
    if csp.ticked(alarm):                                                # 25
        csp.schedule_alarm(alarm, timedelta(seconds=1), True)            # 26
        return s_sum                                                     # 27

Expected behavior
Functional code. :) More seriously, adding pass on line 21 would solve the issue. At the same time one could add from datetime import timedelta to make the code more self-contained.

Error Message

Cell In[8], [line 24](vscode-notebook-cell:?execution_count=8&line=24)
    if csp.ticked(xs, ys) and csp.valid(xs, ys):                         # 22
    ^
IndentationError: expected an indented block after 'with' statement on line 21

Runtime Environment
0.1.0
3.11.7 | packaged by conda-forge | (main, Dec 23 2023, 14:43:09) [GCC 12.3.0]
linux

[ptomecek]

Thanks for the report! I've updated the wiki manually.