summaryrefslogtreecommitdiff
path: root/docs/library/index.rst
diff options
context:
space:
mode:
authorJim Mussared <jim.mussared@gmail.com>2023-06-27 02:17:41 +1000
committerDamien George <damien@micropython.org>2023-07-21 19:32:42 +1000
commitb804443cb3df2ca4b71070739aa1c8f3c86464fc (patch)
treecd293663061bbeeafb4c7208071868bf97c625eb /docs/library/index.rst
parent8b315ef0d82a31991def597906f7f24bd39c6e23 (diff)
docs/library/deflate: Add docs for deflate.DeflateIO.
Also update zlib & gzip docs to describe the micropython-lib modules. This work was funded through GitHub Sponsors. Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
Diffstat (limited to 'docs/library/index.rst')
-rw-r--r--docs/library/index.rst12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst
index 69bc81ade..ae5d3e7d7 100644
--- a/docs/library/index.rst
+++ b/docs/library/index.rst
@@ -64,6 +64,7 @@ library.
collections.rst
errno.rst
gc.rst
+ gzip.rst
hashlib.rst
heapq.rst
io.rst
@@ -95,6 +96,7 @@ the following libraries.
bluetooth.rst
btree.rst
cryptolib.rst
+ deflate.rst
framebuf.rst
machine.rst
micropython.rst
@@ -194,11 +196,11 @@ Extending built-in libraries from Python
A subset of the built-in modules are able to be extended by Python code by
providing a module of the same name in the filesystem. This extensibility
applies to the following Python standard library modules which are built-in to
-the firmware: ``array``, ``binascii``, ``collections``, ``errno``, ``hashlib``,
-``heapq``, ``io``, ``json``, ``os``, ``platform``, ``random``, ``re``,
-``select``, ``socket``, ``ssl``, ``struct``, ``time`` ``zlib``, as well as the
-MicroPython-specific ``machine`` module. All other built-in modules cannot be
-extended from the filesystem.
+the firmware: ``array``, ``binascii``, ``collections``, ``errno``, ``gzip``,
+``hashlib``, ``heapq``, ``io``, ``json``, ``os``, ``platform``, ``random``,
+``re``, ``select``, ``socket``, ``ssl``, ``struct``, ``time`` ``zlib``, as well
+as the MicroPython-specific ``machine`` module. All other built-in modules
+cannot be extended from the filesystem.
This allows the user to provide an extended implementation of a built-in library
(perhaps to provide additional CPython compatibility or missing functionality).