summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-11-16 01:15:25 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-11-16 01:18:19 +0300
commit64db4080cec88c7b3937229a653c65a631732379 (patch)
treeb45b82ac02957547c751cffa1c35023ce12f92b2
parent30bca45e1ac9fc6953728950695135b491403215 (diff)
downloadmicropython-64db4080cec88c7b3937229a653c65a631732379.tar.gz
micropython-64db4080cec88c7b3937229a653c65a631732379.zip
docs/library/index: Elaborate on u-modules.
Also, remove an "only" directive in u-modules description.
-rw-r--r--docs/library/index.rst23
1 files changed, 14 insertions, 9 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst
index b06c806f73..3621f9d880 100644
--- a/docs/library/index.rst
+++ b/docs/library/index.rst
@@ -36,15 +36,20 @@ Python standard libraries and micro-libraries
The following standard Python libraries have been "micro-ified" to fit in with
the philosophy of MicroPython. They provide the core functionality of that
module and are intended to be a drop-in replacement for the standard Python
-library.
-
-.. only:: not port_unix
-
- The modules are available by their u-name, and also by their non-u-name. The
- non-u-name can be overridden by a file of that name in your package path.
- For example, ``import json`` will first search for a file ``json.py`` or
- directory ``json`` and load that package if it is found. If nothing is found,
- it will fallback to loading the built-in ``ujson`` module.
+library. Some modules below use a standard Python name, but prefixed with "u",
+e.g. ``ujson`` instead of ``json``. This is to signify that such a module is
+micro-library, i.e. implements only a subset of CPython module functionality.
+By naming them differently, a user has a choice to write a Python-level module
+to extend functionality for better compatibility with CPython (indeed, this is
+what done by micropython-lib project mentioned above).
+
+On some embedded platforms, where it may be cumbersome to add Python-level
+wrapper modules to achieve naming compatibility with CPython, micro-modules
+are available both by their u-name, and also by their non-u-name. The
+non-u-name can be overridden by a file of that name in your package path.
+For example, ``import json`` will first search for a file ``json.py`` or
+directory ``json`` and load that package if it is found. If nothing is found,
+it will fallback to loading the built-in ``ujson`` module.
.. only:: port_unix