Skip to content

Commit 13b7633

Browse files
author
Benjamin Moody
committed
wr_dat_file: fix documentation of arguments.
The d_signal argument is always a 2D array, and is only used if expanded is false. The e_d_signal argument is always a list of 1D arrays, and is only used if expanded is true.
1 parent 310330b commit 13b7633

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

wfdb/io/_signal.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2266,16 +2266,15 @@ def wr_dat_file(
22662266
fmt : str
22672267
WFDB fmt of the dat file.
22682268
d_signal : ndarray
2269-
The digital conversion of the signal. Either a 2d numpy
2270-
array or a list of 1d numpy arrays.
2269+
The digital conversion of the signal, as a 2d numpy array.
22712270
byte_offset : int
22722271
The byte offset of the dat file.
22732272
expanded : bool, optional
22742273
Whether to transform the `e_d_signal` attribute (True) or
22752274
the `d_signal` attribute (False).
2276-
d_signal : ndarray, optional
2277-
The expanded digital conversion of the signal. Either a 2d numpy
2278-
array or a list of 1d numpy arrays.
2275+
e_d_signal : ndarray, optional
2276+
The expanded digital conversion of the signal, as a list of 1d
2277+
numpy arrays.
22792278
samps_per_frame : list, optional
22802279
The samples/frame for each signal of the dat file.
22812280
write_dir : str, optional

0 commit comments

Comments
 (0)