Skip to content

Commit a857fc2

Browse files
d-v-bmaxrjones
andauthored
Update src/zarr/abc/numcodec.py
Co-authored-by: Max Jones <[email protected]>
1 parent dba39f5 commit a857fc2

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/zarr/abc/numcodec.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,24 @@ class Numcodec(Protocol):
1515
def encode(self, buf: Any) -> Any: ...
1616

1717
def decode(self, buf: Any, out: Any | None = None) -> Any: ...
18+
"""
19+
Decode data in `buf`.
20+
21+
Parameters
22+
----------
23+
buf : Any
24+
Encoded data. May be any object supporting the new-style buffer
25+
protocol.
26+
out : Any
27+
Writeable buffer to store decoded data. N.B. if provided, this buffer must
28+
be exactly the right size to store the decoded data.
29+
30+
Returns
31+
-------
32+
dec : Any
33+
Decoded data. May be any object supporting the new-style
34+
buffer protocol.
35+
"""
1836

1937
def get_config(self) -> Any: ...
2038

0 commit comments

Comments
 (0)