summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--docs/library/index.rst1
-rw-r--r--docs/library/uzlib.rst16
2 files changed, 17 insertions, 0 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst
index fdf35dd0d6..caa62c5a2d 100644
--- a/docs/library/index.rst
+++ b/docs/library/index.rst
@@ -44,6 +44,7 @@ it will fallback to loading the built-in ``ujson`` module.
ujson.rst
ure.rst
usocket.rst
+ uzlib.rst
Libraries specific to the pyboard
---------------------------------
diff --git a/docs/library/uzlib.rst b/docs/library/uzlib.rst
new file mode 100644
index 0000000000..dc84371fca
--- /dev/null
+++ b/docs/library/uzlib.rst
@@ -0,0 +1,16 @@
+:mod:`uzlib` -- zlib decompression
+==================================
+
+.. module:: uzlib
+ :synopsis: zlib decompression
+
+This modules allows to decompress binary data compressed with DEFLATE
+algorithm (commonly used in zlib libarary and gzip archiver). Compression
+is not yet implemented.
+
+Functions
+---------
+
+.. function:: decompress(data)
+
+ Return decompressed data as bytes.