fix: docstring consistency in screening.py #207
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Template
Description
@hspark1212 noticed an inconsistency between the docstrings of
pauling_test
andeneg_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.
How Has This Been Tested?
No code changes.
Reviewers
@AntObi - maybe someone can check that the readthedocs page is updated properly after?
Checklist: