The new "Hosting multiple controllers" subsection in docs/how-to/launch-framework.md (added in #360 / commit f6600bc for #359) anchors its prose to the bundled demo:
The bundled demo (python -m fastcs.demo run src/fastcs/demo/fastcs.yaml) hosts two DeviceController instances on different ports to exercise this case end-to-end:
…but the example below this prose doesn't match what the demo actually does:
|
Doc example |
Actual demo (src/fastcs/demo/fastcs.yaml) |
| Class |
DeviceController |
TemperatureController |
| Connection settings |
flat ip_address: ... + port: ... + timeout: 10.0 |
nested ip_settings: { ip: ..., port: ... } + num_ramp_controllers: ... |
| AUX port |
25565 (same as MAIN, with a different IP) |
25566 (same IP, different port) |
The doc paragraph literally tells the reader "this is what the demo does", then shows a yaml shape the demo cannot accept. The rest of the file uses DeviceController as a placeholder class throughout, so the placeholder-vs-real conflict is local to this paragraph.
Suggested fix
Either:
- (A) Drop the "the bundled demo hosts…" sentence and keep the example as a generic
DeviceController illustration, with a separate one-liner pointing readers at src/fastcs/demo/fastcs.yaml for a real working example; or
- (B) Replace the example with the actual demo's yaml (real
TemperatureController shape, ports 25565/25566), so the prose's "this is what the demo does" claim is true.
(A) is probably cheaper — keeping a synthetic example consistent with the rest of the file and adding a pointer to the real demo file is one line of prose.
Found while reviewing PR #360 commit-by-commit.
The new "Hosting multiple controllers" subsection in
docs/how-to/launch-framework.md(added in #360 / commit f6600bc for #359) anchors its prose to the bundled demo:…but the example below this prose doesn't match what the demo actually does:
src/fastcs/demo/fastcs.yaml)DeviceControllerTemperatureControllerip_address: ...+port: ...+timeout: 10.0ip_settings: { ip: ..., port: ... }+num_ramp_controllers: ...The doc paragraph literally tells the reader "this is what the demo does", then shows a yaml shape the demo cannot accept. The rest of the file uses
DeviceControlleras a placeholder class throughout, so the placeholder-vs-real conflict is local to this paragraph.Suggested fix
Either:
DeviceControllerillustration, with a separate one-liner pointing readers atsrc/fastcs/demo/fastcs.yamlfor a real working example; orTemperatureControllershape, ports 25565/25566), so the prose's "this is what the demo does" claim is true.(A) is probably cheaper — keeping a synthetic example consistent with the rest of the file and adding a pointer to the real demo file is one line of prose.
Found while reviewing PR #360 commit-by-commit.