Skip to content

Commit 04ae55f

Browse files
author
Benjamin Moody
committed
Fix documentation of the internal variable 'filebytes'.
This variable contains the complete contents of the input annotation file, as a numpy array of pairs of bytes (shape=(N,2), dtype='uint8'). It is neither a str nor a bytes object.
1 parent 6be3066 commit 04ae55f

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

wfdb/io/annotation.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1748,8 +1748,8 @@ def load_byte_pairs(record_name, extension, pn_dir):
17481748
17491749
Returns
17501750
-------
1751-
filebytes : str
1752-
The input filestream converted to bytes.
1751+
filebytes : ndarray
1752+
The input filestream converted to an Nx2 array of unsigned bytes.
17531753
17541754
"""
17551755
# local file
@@ -1769,8 +1769,8 @@ def proc_ann_bytes(filebytes, sampto):
17691769
17701770
Parameters
17711771
----------
1772-
filebytes : str
1773-
The input filestream converted to bytes.
1772+
filebytes : ndarray
1773+
The input filestream converted to an Nx2 array of unsigned bytes.
17741774
sampto : int
17751775
The maximum sample number for annotations to be returned.
17761776
@@ -1852,8 +1852,8 @@ def proc_core_fields(filebytes, bpi):
18521852
18531853
Parameters
18541854
----------
1855-
filebytes : str
1856-
The input filestream converted to bytes.
1855+
filebytes : ndarray
1856+
The input filestream converted to an Nx2 array of unsigned bytes.
18571857
bpi : int
18581858
The index to start the conversion.
18591859

0 commit comments

Comments
 (0)