Skip to content

Commit 641c686

Browse files
author
Benjamin Moody
committed
wfdb.plot.plot: rename get_plot_dims to _get_plot_dims.
This function is not in the wfdb module, is not listed in the documentation, and shouldn't be used by applications directly.
1 parent 41ebfb5 commit 641c686

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

tests/test_plot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ def test_get_plot_dims(self):
1313
ann = wfdb.rdann(
1414
"sample-data/100", "atr", sampfrom=sampfrom, sampto=sampto
1515
)
16-
sig_len, n_sig, n_annot, n_subplots = plot.get_plot_dims(
16+
sig_len, n_sig, n_annot, n_subplots = plot._get_plot_dims(
1717
signal=record.p_signal, ann_samp=[ann.sample]
1818
)
1919

wfdb/plot/plot.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ def plot_items(
249249
signal = _expand_channels(signal)
250250

251251
# Figure out number of subplots required
252-
sig_len, n_sig, n_annot, n_subplots = get_plot_dims(signal, ann_samp)
252+
sig_len, n_sig, n_annot, n_subplots = _get_plot_dims(signal, ann_samp)
253253

254254
# Convert sampling_freq and ann_freq to lists if needed
255255
sampling_freq = _get_sampling_freq(sampling_freq, n_sig, fs)
@@ -334,7 +334,7 @@ def plot_items(
334334
plt.show()
335335

336336

337-
def get_plot_dims(signal, ann_samp):
337+
def _get_plot_dims(signal, ann_samp):
338338
"""
339339
Figure out the number of plot channels.
340340

0 commit comments

Comments
 (0)