Skip to content
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

Enable old Boltzmann key with DeprecationWarning #4230

Merged
merged 5 commits into from
Aug 10, 2023

Conversation

xhgchen
Copy link
Member

@xhgchen xhgchen commented Aug 9, 2023

Fixes #4229

Changes made in this Pull Request:

  • Provide old 'Boltzman_constant' key in subclassed dict and wrap __getitem__ with DeprecationWarning
  • Add test for old 'Boltzman_constant' key
  • Add test for deprecation warning with old 'Boltzman_constant' key

PR Checklist

  • Tests?
  • CHANGELOG updated?
  • Issue raised/referenced?

Developers certificate of origin


📚 Documentation preview 📚: https://mdanalysis--4230.org.readthedocs.build/en/4230/

* Subclass dict and wrap `__getitem__` with `DeprecationWarning`
* Add test for old `Boltzman_constant` key
* Add test for deprecation warning with old `Boltzman_constant` key
@github-actions
Copy link

github-actions bot commented Aug 9, 2023

Linter Bot Results:

Hi @xhgchen! Thanks for making this PR. We linted your code and found the following:

Some issues were found with the formatting of your code.

Code Location Outcome
main package ⚠️ Possible failure
testsuite ⚠️ Possible failure

Please have a look at the darker-main-code and darker-test-code steps here for more details: https://github.com/MDAnalysis/mdanalysis/actions/runs/5815028750/job/15765827233


Please note: The black linter is purely informational, you can safely ignore these outcomes if there are no flake8 failures!

Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changelog entry please

package/CHANGELOG Outdated Show resolved Hide resolved
@xhgchen
Copy link
Member Author

xhgchen commented Aug 9, 2023

Done! Was just in the middle of doing it as you replied 😅

@codecov
Copy link

codecov bot commented Aug 9, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (2bf55dd) 93.62% compared to head (874a8df) 93.62%.
Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4230   +/-   ##
========================================
  Coverage    93.62%   93.62%           
========================================
  Files          193      193           
  Lines        25295    25304    +9     
  Branches      4063     4064    +1     
========================================
+ Hits         23683    23692    +9     
  Misses        1096     1096           
  Partials       516      516           
Files Changed Coverage Δ
package/MDAnalysis/units.py 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@xhgchen
Copy link
Member Author

xhgchen commented Aug 9, 2023

Some issues are appearing with the CI and Codecov, but I don't think they're from my PR.

@hmacdope
Copy link
Member

Thanks for sorting this out @xhgchen :)

@IAlibay IAlibay merged commit bd3c14c into MDAnalysis:develop Aug 10, 2023
22 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fixing spelling of Boltzmann constant typo in MDAnalysis.units is an API break
3 participants