Skip to content

Commit

Permalink
Update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
AntObi committed Jul 10, 2024
1 parent 9c81d5e commit 55dfa8c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions smact/dopant_prediction/doper.py
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ def get_dopants(
group_by_charge (bool): Whether to group the dopants by charge.
Returns:
(dict): Dopant suggestions, given as a dictionary with keys
"n_type_cation", "p_type_cation", "n_type_anion", "p_type_anion".
"n-type cation substitutions", "p-type cation substitutions", "n-type anion substitutions", "p-type anion substitutions".
Examples:
>>> test = Doper(('Ti4+','O2-'))
Expand Down Expand Up @@ -373,11 +373,11 @@ def get_dopants(
# return the top (num_dopants) results for each case
return self.results

def plot_dopants(self, cmap="YlOrRd") -> None:
def plot_dopants(self, cmap: str = "YlOrRd") -> None:
"""
Plot the dopant suggestions using the periodic table heatmap.
Args:
None
cmap (str): The colormap to use for the heatmap.
Returns:
None
"""
Expand Down

0 comments on commit 55dfa8c

Please sign in to comment.