Skip to content

Commit 355ff1d

Browse files
committed
address doc-string comments
1 parent e4a2b50 commit 355ff1d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/lobsterpy/plotting/__init__.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ class PlainCohpPlotter(CohpPlotter):
5858
:param zero_at_efermi: Shift all populations to have zero
5959
energy at the Fermi level. Defaults to True.
6060
:param are_coops: Bool indicating that populations are COOPs, not COHPs.
61-
Defaults to False for COHPs.
61+
Defaults to False, i.e., COHPs are plotted.
6262
:param are_cobis: Bool indicating that populations are COBIs, not COHPs.
63-
Defaults to False for COHPs.
63+
Defaults to False, i.e., ICOHPs are plotted.
6464
"""
6565

6666
def get_plot(
@@ -519,9 +519,9 @@ class InteractiveCohpPlotter(CohpPlotter):
519519
:param zero_at_efermi: Shift all populations to have zero
520520
energy at the Fermi level. Defaults to True.
521521
:param are_coops: Bool indicating that populations are COOPs, not COHPs.
522-
Defaults to False for COHPs.
522+
Defaults to False, i.e., COHPs are plotted.
523523
:param are_cobis: Bool indicating that populations are COBIs, not COHPs.
524-
Defaults to False for COHPs.
524+
Defaults to False, i.e., COHPs are plotted.
525525
"""
526526

527527
COLOR_PALETTE = [
@@ -1088,9 +1088,9 @@ class IcohpDistancePlotter:
10881088
Plotter to generate ICOHP or ICOBI or ICOOP vs bond lengths plots.
10891089
10901090
:param are_coops: Bool indicating that populations are ICOOPs, not ICOHPs.
1091-
Defaults to False for COHPs.
1091+
Defaults to False, i.e., ICOHPs are plotted.
10921092
:param are_cobis: Bool indicating that populations are ICOBIs, not ICOHPs.
1093-
Defaults to False for COHPs.
1093+
Defaults to False, i.e., ICOHPs are plotted.
10941094
"""
10951095

10961096
COLOR_PALETTE = [
@@ -1195,7 +1195,7 @@ def get_plot(
11951195
ax.set_xlabel("Bond lengths (\u00c5)")
11961196

11971197
if color_interactions:
1198-
colors = InteractiveCohpPlotter.COLOR_PALETTE if colors is None else colors
1198+
colors = self.COLOR_PALETTE if colors is None else colors
11991199
atom_types = []
12001200
for data in self._icohps.values():
12011201
atom_types.extend(list(set(data["atom_types"])))
@@ -1242,9 +1242,9 @@ class BWDFPlotter:
12421242
Plotter to generate Bond weighted distribution functions using ICOHP or ICOBI or ICOOP as weights.
12431243
12441244
:param are_coops: Bool indicating that populations are ICOOPs, not ICOHPs.
1245-
Defaults to False for COHPs.
1245+
Defaults to False, i.e., ICOHPs are plotted.
12461246
:param are_cobis: Bool indicating that populations are ICOBIs, not ICOHPs.
1247-
Defaults to False for COHPs.
1247+
Defaults to False, i.e., ICOHPs are plotted.
12481248
"""
12491249

12501250
COLOR_PALETTE = [
@@ -1338,7 +1338,7 @@ def get_plot(
13381338
if ylim:
13391339
ax.set_ylim(ylim)
13401340

1341-
palette = InteractiveCohpPlotter.COLOR_PALETTE if colors is None else colors
1341+
palette = self.COLOR_PALETTE if colors is None else colors
13421342
pal_iter = cycle(palette)
13431343

13441344
for label, bwdf in self._bwdfs.items():

0 commit comments

Comments
 (0)