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.

Sign up for GitHub

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

Jump to bottom

fix: docstring consistency in screening.py #207

Merged
merged 1 commit into from
Jan 18, 2024
Merged

fix: docstring consistency in screening.py #207

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions smact/screening.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ def pauling_test(

Returns:
bool:
True if positive ions have lower
electronegativity than negative ions
True if anions are more electronegative than
cations, otherwise False
"""

if repeat_anions and repeat_cations and threshold == 0.0:
Expand Down Expand Up @@ -135,8 +135,8 @@ def pauling_test_old(

Returns:
(bool):
True if positive ions have lower
electronegativity than negative ions
True if anions are more electronegative than
cations, otherwise False

"""
if None in paul:
Expand Down Expand Up @@ -192,8 +192,8 @@ def eneg_states_test(ox_states: List[int], enegs: List[float]):
compound

Returns:
bool : True if cations have higher electronegativity than
anions, otherwise False
bool : True if anions are more electronegative than
cations, otherwise False

"""
for (ox1, eneg1), (ox2, eneg2) in combinations(
Expand Down Expand Up @@ -231,8 +231,8 @@ def eneg_states_test_threshold(
the Pauling criterion

Returns:
bool : True if cations have higher electronegativity than
anions, otherwise False
bool : True if anions are more electronegative than
cations, otherwise False

"""
for (ox1, eneg1), (ox2, eneg2) in combinations(
Expand All @@ -259,8 +259,8 @@ def eneg_states_test_alternate(ox_states: List[int], enegs: List[float]):
compound

Returns:
bool : True if cations have higher electronegativity than
anions, otherwise False
bool : True if anions are more electronegative than
cations, otherwise False

"""
min_cation_eneg, max_anion_eneg = 10, 0
Expand Down