Skip to content

Commit adf4c4c

Browse files
committed
docs: Add quick docs for uzlib.
1 parent c0b3d45 commit adf4c4c

2 files changed

Lines changed: 17 additions & 0 deletions

File tree

docs/library/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ it will fallback to loading the built-in ``ujson`` module.
4444
ujson.rst
4545
ure.rst
4646
usocket.rst
47+
uzlib.rst
4748

4849
Libraries specific to the pyboard
4950
---------------------------------

docs/library/uzlib.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:mod:`uzlib` -- zlib decompression
2+
==================================
3+
4+
.. module:: uzlib
5+
:synopsis: zlib decompression
6+
7+
This modules allows to decompress binary data compressed with DEFLATE
8+
algorithm (commonly used in zlib libarary and gzip archiver). Compression
9+
is not yet implemented.
10+
11+
Functions
12+
---------
13+
14+
.. function:: decompress(data)
15+
16+
Return decompressed data as bytes.

0 commit comments

Comments
 (0)