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

Tidy up docstrings, add Level.is_observed property #321

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

wtbarnes
Copy link
Owner

This PR actually renders the docstring of the function added in #320 and also tidies up docstrings all over the package, many of which have been missing for a long time.

The only feature this adds is the property Level.is_observed to denote whether the energy of a level is taken from laboratory measurements or theoretical calculations.

Copy link

codecov bot commented Sep 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.54%. Comparing base (a661c8c) to head (37fda76).
Report is 15 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #321      +/-   ##
==========================================
+ Coverage   90.51%   90.54%   +0.02%     
==========================================
  Files          40       40              
  Lines        3384     3394      +10     
==========================================
+ Hits         3063     3073      +10     
  Misses        321      321              

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

@wtbarnes wtbarnes merged commit f996aea into main Sep 30, 2024
14 checks passed
@wtbarnes wtbarnes deleted the more-docstring-fixups branch September 30, 2024 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant