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

fix: docstring consistency in screening.py #207

Merged
merged 1 commit into from
Jan 18, 2024

Conversation

dandavies99
Copy link
Member

Pull Request Template

Description

@hspark1212 noticed an inconsistency between the docstrings of pauling_test and eneg_states_test, the latter of which was incorrect.

These changes make the wording in the docstrings for similar functions more consistent and hopefully less confusing, steering clear of words like "higher" and "lower" when dealing with electronegativity values which are all positive, and more positive for more electronegative elements.

Type of change

Please delete options that are not relevant.

  • docstring change only

How Has This Been Tested?

No code changes.

Reviewers

@AntObi - maybe someone can check that the readthedocs page is updated properly after?

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Copy link

codecov bot commented Jan 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a3f6f74) 73.10% compared to head (e8bcb6b) 73.05%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #207      +/-   ##
==========================================
- Coverage   73.10%   73.05%   -0.06%     
==========================================
  Files          24       24              
  Lines        1952     1952              
==========================================
- Hits         1427     1426       -1     
- Misses        525      526       +1     

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

Copy link
Collaborator

@AntObi AntObi left a comment

Choose a reason for hiding this comment

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

The docs have been updated successfully as seen in here: https://smact--207.org.readthedocs.build/en/207/smact.screening.html#smact.screening.pauling_test

Happy to merge this!

@AntObi AntObi merged commit 26b6a05 into master Jan 18, 2024
15 of 16 checks passed
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.

2 participants