-
Notifications
You must be signed in to change notification settings - Fork 648
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixing spelling of Boltzmann constant typo in MDAnalysis.units is an API break #4229
Comments
I used |
Thats sounds like a perfectly reasonable and easy fix, along with a deprecation warning for the old spelling. |
I would be happy to look into making this change tomorrow, unless someone else is keen on it or has a better approach :) |
I'm going to let the other @MDAnalysis/coredevs weigh in here - please work out if you this needs changing & make sure it is actioned by end of week. (it's blocking the next release) |
I agree with @xhgchen — make the wrong spelling available again for the next two 2.x releases. Add a deprecation note to CHANGELOG and docs. I’d skip having code issue a warning as it sounds like a very low impact deprecation… or am I wrong there? |
Subclassing the dictionary and wrapping |
If you consider it a "bug fix" the API break should formally be allowed I think, since bug fixes > API issues, but making the incorrect spelling available for a bit longer seems reasonable if folks want it. |
Fixing #4213 with #4214 by @xhgchen adjusting the spelling of Boltzmann constant typo in MDAnalysis.units is technically an API break, in that if anyone relied on pulling the constant by name we broke that for them.
Pinging @MDAnalysis/coredevs do we think this is an issue or not.
The text was updated successfully, but these errors were encountered: