Skip to content

Commit ffb9d52

Browse files
committed
update docstrings for changes
1 parent 0a85b2a commit ffb9d52

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

fooof/plts/spectra.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,13 @@
2424
@check_dependency(plt, 'matplotlib')
2525
def plot_spectra(freqs, power_spectra, log_freqs=False, log_powers=False,
2626
colors=None, labels=None, ax=None, **plot_kwargs):
27-
"""Plot multiple power spectra on the same plot.
27+
"""Plot one or multiple power spectra.
2828
2929
Parameters
3030
----------
31-
freqs : 2d array or 1d array or list of 1d array
31+
freqs : 1d or 2d array or list of 1d array
3232
Frequency values, to be plotted on the x-axis.
33-
power_spectra : 2d array or list of 1d array
33+
power_spectra : 1d or 2d array or list of 1d array
3434
Power values, to be plotted on the y-axis.
3535
log_freqs : bool, optional, default: False
3636
Whether to plot the frequency axis in log spacing.
@@ -79,13 +79,13 @@ def plot_spectra(freqs, power_spectra, log_freqs=False, log_powers=False,
7979
@check_dependency(plt, 'matplotlib')
8080
def plot_spectra_shading(freqs, power_spectra, shades, shade_colors='r',
8181
add_center=False, ax=None, **plot_kwargs):
82-
"""Plot a group of power spectra with a shaded frequency region (or regions).
82+
"""Plot one or multiple power spectra with a shaded frequency region (or regions).
8383
8484
Parameters
8585
----------
86-
freqs : 2d array or 1d array or list of 1d array
86+
freqs : 1d or 2d array or list of 1d array
8787
Frequency values, to be plotted on the x-axis.
88-
power_spectra : 2d array or list of 1d array
88+
power_spectra : 1d or 2d array or list of 1d array
8989
Power values, to be plotted on the y-axis.
9090
shades : list of [float, float] or list of list of [float, float]
9191
Shaded region(s) to add to plot, defined as [lower_bound, upper_bound].

0 commit comments

Comments
 (0)