diff options
| author | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2014-12-05 00:40:21 +0200 |
|---|---|---|
| committer | Paul Sokolovsky <pfalcon@users.sourceforge.net> | 2014-12-05 00:40:35 +0200 |
| commit | adf4c4cea8560e84c96b42eaec7ea6658012058a (patch) | |
| tree | 7a77e2f906f650eb8e7cf62933ecf05b9e7fcbb0 /docs | |
| parent | c0b3d4540bdc31ea65fde178bb3a507c034dcc14 (diff) | |
| download | micropython-adf4c4cea8560e84c96b42eaec7ea6658012058a.tar.gz micropython-adf4c4cea8560e84c96b42eaec7ea6658012058a.zip | |
docs: Add quick docs for uzlib.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/library/index.rst | 1 | ||||
| -rw-r--r-- | docs/library/uzlib.rst | 16 |
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. |