Skip to content

Commit b574f16

Browse files
FrancescAltedmartaiborra
authored andcommitted
Document the dst param
1 parent 86b179c commit b574f16

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

blosc2/utils.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,11 @@ def decompress(src, dst=None, as_bytearray=False):
100100
The data to be decompressed. Must be a bytes-like object
101101
that supports the Python Buffer Protocol, like bytes, bytearray,
102102
memoryview, or numpy.ndarray.
103+
dst : NumPy object
104+
The destination NumPy object to fill. The user must make sure
105+
that it has enough capacity for hosting the decompressed data.
106+
Default is None, meaning that a new `bytes` or `bytearray` object
107+
is created, filled and returned.
103108
as_bytearray : bool (optional)
104109
If this flag is True then the return type will be a bytearray object
105110
instead of a bytesobject.

0 commit comments

Comments
 (0)