summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim Mussared <jim.mussared@gmail.com>2021-12-11 23:39:40 +1100
committerDamien George <damien@micropython.org>2021-12-18 00:08:07 +1100
commit86394f70fcd7b9fa66ec952711e5d64557d81a1e (patch)
tree72a6f9503bc9bba01e553e0961f290004b022d07
parent86ce4426079b1b368881c22f46d80045e2f720b0 (diff)
docs/library/sys.rst: Add note about '.frozen' as an entry in sys.path.
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
-rw-r--r--docs/library/sys.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/library/sys.rst b/docs/library/sys.rst
index 80ac1ab84..d36394c88 100644
--- a/docs/library/sys.rst
+++ b/docs/library/sys.rst
@@ -115,6 +115,14 @@ Constants
A mutable list of directories to search for imported modules.
+ .. admonition:: Difference to CPython
+ :class: attention
+
+ On MicroPython, an entry with the value ``".frozen"`` will indicate that import
+ should search :term:`frozen modules <frozen module>` at that point in the search.
+ If no frozen module is found then search will *not* look for a directory called
+ ``.frozen``, instead it will continue with the next entry in ``sys.path``.
+
.. data:: platform
The platform that MicroPython is running on. For OS/RTOS ports, this is