Skip to content

Commit 0b1aa8f

Browse files
author
Benjamin Moody
committed
plot.plot: simplify wording in documentation.
1 parent 5764124 commit 0b1aa8f

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

wfdb/plot/plot.py

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ def _expand_channels(signal):
1515
Parameters
1616
----------
1717
signal : 1d or 2d numpy array or list or None
18-
The uniformly sampled signal or signals to be plotted. If signal
19-
is a one-dimensional array, it is assumed to represent a single
20-
channel. If it is a two-dimensional array, axes 0 and 1 must
21-
represent time and channel number respectively. Otherwise it must
22-
be a list of one-dimensional arrays (one for each channel.)
18+
The signal or signals to be plotted. If signal is a
19+
one-dimensional array, it is assumed to represent a single channel.
20+
If it is a two-dimensional array, axes 0 and 1 must represent time
21+
and channel number respectively. Otherwise it must be a list of
22+
one-dimensional arrays (one for each channel.)
2323
2424
Returns
2525
-------
@@ -124,11 +124,11 @@ def plot_items(signal=None, ann_samp=None, ann_sym=None, fs=None,
124124
Parameters
125125
----------
126126
signal : 1d or 2d numpy array or list, optional
127-
The uniformly sampled signal or signals to be plotted. If signal
128-
is a one-dimensional array, it is assumed to represent a single
129-
channel. If it is a two-dimensional array, axes 0 and 1 must
130-
represent time and channel number respectively. Otherwise it must
131-
be a list of one-dimensional arrays (one for each channel).
127+
The signal or signals to be plotted. If signal is a
128+
one-dimensional array, it is assumed to represent a single channel.
129+
If it is a two-dimensional array, axes 0 and 1 must represent time
130+
and channel number respectively. Otherwise it must be a list of
131+
one-dimensional arrays (one for each channel).
132132
ann_samp: list, optional
133133
A list of annotation locations to plot, with each list item
134134
corresponding to a different channel. List items may be:
@@ -281,11 +281,11 @@ def get_plot_dims(signal, ann_samp):
281281
Parameters
282282
----------
283283
signal : 1d or 2d numpy array or list, optional
284-
The uniformly sampled signal or signals to be plotted. If signal
285-
is a one-dimensional array, it is assumed to represent a single
286-
channel. If it is a two-dimensional array, axes 0 and 1 must
287-
represent time and channel number respectively. Otherwise it must
288-
be a list of one-dimensional arrays (one for each channel).
284+
The signal or signals to be plotted. If signal is a
285+
one-dimensional array, it is assumed to represent a single channel.
286+
If it is a two-dimensional array, axes 0 and 1 must represent time
287+
and channel number respectively. Otherwise it must be a list of
288+
one-dimensional arrays (one for each channel).
289289
ann_samp: list, optional
290290
A list of annotation locations to plot, with each list item
291291
corresponding to a different channel. List items may be:
@@ -373,11 +373,11 @@ def plot_signal(signal, sig_len, n_sig, fs, time_units, sig_style, axes,
373373
Parameters
374374
----------
375375
signal : 1d or 2d numpy array or list
376-
The uniformly sampled signal or signals to be plotted. If signal
377-
is a one-dimensional array, it is assumed to represent a single
378-
channel. If it is a two-dimensional array, axes 0 and 1 must
379-
represent time and channel number respectively. Otherwise it must
380-
be a list of one-dimensional arrays (one for each channel).
376+
The signal or signals to be plotted. If signal is a
377+
one-dimensional array, it is assumed to represent a single channel.
378+
If it is a two-dimensional array, axes 0 and 1 must represent time
379+
and channel number respectively. Otherwise it must be a list of
380+
one-dimensional arrays (one for each channel).
381381
sig_len : int
382382
The signal length (per channel) of the dat file. Deprecated.
383383
n_sig : int
@@ -457,11 +457,11 @@ def plot_annotation(ann_samp, n_annot, ann_sym, signal, n_sig, fs, time_units,
457457
ann_sym : list
458458
The values of the annotation symbol locations.
459459
signal : 1d or 2d numpy array or list
460-
The uniformly sampled signal or signals to be plotted. If signal
461-
is a one-dimensional array, it is assumed to represent a single
462-
channel. If it is a two-dimensional array, axes 0 and 1 must
463-
represent time and channel number respectively. Otherwise it must
464-
be a list of one-dimensional arrays (one for each channel).
460+
The signal or signals to be plotted. If signal is a
461+
one-dimensional array, it is assumed to represent a single channel.
462+
If it is a two-dimensional array, axes 0 and 1 must represent time
463+
and channel number respectively. Otherwise it must be a list of
464+
one-dimensional arrays (one for each channel).
465465
n_sig : int
466466
The number of signals contained in the dat file.
467467
fs : float

0 commit comments

Comments
 (0)