ALPHA-g-Experiment / alpha-g

MIT License
1 stars 1 forks source link

Add documentation on `board_name` output for the chronobox binary #153

Open DJDuque opened 4 months ago

DJDuque commented 4 months ago

The board_name is really only a "human-understandable" identifier of a chronobox (cb01, cb02, cb03, cb04). There is no guarantee at all (not even in alpha-g-detector) that these names will match whatever is in the ODB. Neither the chronobox binary, nor alpha-g-detector will attempt to keep track of ODB changes, etc.

Make it explicit in the docs for both alpha-g-detector::chronobox::BoardId and the README file for the chronobox binary.

DJDuque commented 4 months ago

Nonetheless, make a guarantee that changing this "human-readable" name will be considered a breaking change (this guarantee is important for high-level tools like e.g. the data-handler).