search

open-ephys / bonsai-onix1

Bonsai library for the Open Ephys Onix Acquisition System
https://open-ephys.github.io/onix1-bonsai-docs
MIT License
4 stars 3 forks source link

Change `BreakoutAnalogInput` to `AnalogInput` #300

Closed cjsha closed 2 weeks ago

cjsha commented 2 weeks ago

This same change can be applied to BreakoutAnalogOutput, BreakoutDigitalInput, and BreakoutDigitalOutput.

@jonnew mentioned this to me off-handedly that he doesn't like the current naming convention and I think it's worth discussing. It seems redundant, and I'm not sure what the benefit is.

bparks13 commented 2 weeks ago

This change can actually be done for v0.3.0, since we are utilizing the [Obsolete] tag to not break workflows. Especially since we are still in a 0.y.z version and it is considered "unstable". The change that needs to be made for v1.0.0 would be to remove these obsolete classes entirely, since that would break workflows.

cjsha commented 2 weeks ago

Classes with obsolete attributes are not searchable modules in Bonsai, correct? Just curious/confirming what the Bonsai UX would be like in the meanwhile.

bparks13 commented 2 weeks ago

@cjsha Correct, they are not searchable, but if they exist in a workflow file they will be loaded correctly. Hence, this does not break existing workflows. There is a visual indicator that they might be obsolete, the color is correct but they do have cross-hatches. I linked an issue in the docs repo stating that we need to update the workflows to ensure that the SVGs on the website don't show this cross-hatching.