You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Follow-up from #50. Four small items, all documentation.
DESIGN.md:48 lists the settable-property table row | circuit | switch/relay | Updates the RelayResolver user override | unconditionally. As of 0.7.0 that row is per-circuit: a locked circuit declares no $settable on switch/relay and never reaches the handler. The precedence block a few lines below (:59) was updated in the PR; this table was not.
README.md:92-97, the new paragraph on what locked means, is hard-wrapped at roughly 90 columns. Every other prose paragraph in that file is a single unwrapped line; 21 lines in the file exceed 200 characters. Reflow to one line per paragraph to match.
The citation is the weakest of the three available.relay_resolver.py's module docstring, relay_locked's docstring and DESIGN.md:59 all lean on devices/distribution-enclosure.md:250, "the enclosure never opens a circuit commissioned as permanently OFF_GRID / locked". Read on its own, "commissioned as permanently OFF_GRID" is the never-backup case, which the enclosure does open when off-grid, so the sentence reads backwards until you already know the conclusion. Two sources say it outright:
capabilities/switch.md, relay-controllable: "True = the relay can be opened and closed by command or automatic shed. False = locked." This one is vendored verbatim in wire/catalogs/switch.json, so citing it makes the argument checkable without a specification checkout.
integration-guides/bess-and-distribution-enclosure.md:191: "A circuit's relay is opened by shedding only when it is controllable; the enclosure never opens a circuit commissioned as permanently OFF_GRID-locked or otherwise non-controllable."
The specification-side wording is filed separately at electrification-bus/specification.
Follow-up from #50. Four small items, all documentation.
DESIGN.md:48lists the settable-property table row| circuit | switch/relay | Updates the RelayResolver user override |unconditionally. As of 0.7.0 that row is per-circuit: a locked circuit declares no$settableonswitch/relayand never reaches the handler. The precedence block a few lines below (:59) was updated in the PR; this table was not.manifest_physics.relay_locked's docstring ends "Absent metadata is controllable, which is what a manifest that declares no relay behaviour at all means." No manifest can reach that branch:_parse_circuitrequiresrelay-behavioratmanifest_physics.py:428. The sentence is true only of the standalonebuild_graphpath, which is worth saying explicitly (see_settable_forderives the locked bit from unvalidated metadata, so a mistypedrelay-behaviorsilently locks the circuit #53).README.md:92-97, the new paragraph on what locked means, is hard-wrapped at roughly 90 columns. Every other prose paragraph in that file is a single unwrapped line; 21 lines in the file exceed 200 characters. Reflow to one line per paragraph to match.The citation is the weakest of the three available.
relay_resolver.py's module docstring,relay_locked's docstring andDESIGN.md:59all lean ondevices/distribution-enclosure.md:250, "the enclosure never opens a circuit commissioned as permanentlyOFF_GRID/ locked". Read on its own, "commissioned as permanently OFF_GRID" is the never-backup case, which the enclosure does open when off-grid, so the sentence reads backwards until you already know the conclusion. Two sources say it outright:capabilities/switch.md,relay-controllable: "True = the relay can be opened and closed by command or automatic shed. False = locked." This one is vendored verbatim inwire/catalogs/switch.json, so citing it makes the argument checkable without a specification checkout.integration-guides/bess-and-distribution-enclosure.md:191: "A circuit's relay is opened by shedding only when it is controllable; the enclosure never opens a circuit commissioned as permanentlyOFF_GRID-locked or otherwise non-controllable."The specification-side wording is filed separately at electrification-bus/specification.