circuitpython/docs/library/uzlib.rst

:mod:`uzlib` -- zlib decompression
==================================

.. module:: uzlib
   :synopsis: zlib decompression

|see_cpython_module| :mod:`python:zlib`.

This modules allows to decompress binary data compressed with DEFLATE
algorithm (commonly used in zlib library and gzip archiver). Compression
is not yet implemented.

Functions
---------

.. function:: decompress(data)

   Return decompressed data as bytes.
docs: Add quick docs for uzlib. 2014-12-04 17:40:21 -05:00			:mod:`uzlib` -- zlib decompression
			`==================================`

			`.. module:: uzlib`
			`:synopsis: zlib decompression`

docs/library: Add CPython docs xref to each pertinent module. Cross-reference text/link is implemented as RST substitution, so easy to consistently. 2017-07-02 08:37:31 -04:00			\|see_cpython_module\| :mod:`python:zlib`.

docs: Add quick docs for uzlib. 2014-12-04 17:40:21 -05:00			`This modules allows to decompress binary data compressed with DEFLATE`
docs: uzlib: Typo fix. 2014-12-04 19:08:30 -05:00			`algorithm (commonly used in zlib library and gzip archiver). Compression`
docs: Add quick docs for uzlib. 2014-12-04 17:40:21 -05:00			`is not yet implemented.`

			`Functions`
			`---------`

			`.. function:: decompress(data)`

			`Return decompressed data as bytes.`