Remove Breakout prefix from classes where its redundant

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

Remove Breakout prefix from classes where its redundant #301

Closed jonnew closed 2 weeks ago

jonnew commented 2 weeks ago

Preserve backwards compatibility with old workflows.
~This commit requires a major revision increment~ Because we are in the 0 major revision, this change is permitted, even though its API breaking
Fixes #297
Fixes #300
After this is merged, I will create 1.0.0 issue requesting the removal of obsolete types

jonnew commented 2 weeks ago

Thanks for the review. The big issue we need to consider is do we put effort into maintaining backwards compatibility when we are in version 0.X.X? Im in the middle of refactoring the Bno055 to create a common class for all headstages that perform polling. Should I add these obsolete derived classes there as well? I guess so?

bparks13 commented 2 weeks ago

I guess the question for BNO is what is the opportunity cost for adding the obsolete derived classes? I'm guessing there aren't many workflows that depend on this yet, but I think it would be good to add the derived classes if it is easy to do, and then remove the obsolete classes once we reach 1.0

jonnew commented 2 weeks ago

That's precisely what I was thinking as well. I will add them to the refactored Bno stuff. I also realized you can put a note in the [Obsolete] attribute. We will state there they will be removed in 1.0.0