8000 docs/library/index: Add intro paragraph regarding availability of mod… · lapsule/micropython@09f764d · GitHub
[go: up one dir, main page]

Skip to content

Commit 09f764d

Browse files
committed
docs/library/index: Add intro paragraph regarding availability of modules.
This introductions makes explicit the fact that whenever possible, the documentation describes full MicroPython functionality, and arbitrary functions/classes/modules may be missing in a paricular port or build.
1 parent 9a1a49c commit 09f764d

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

docs/library/index.rst

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,33 @@
11
MicroPython libraries
22
=====================
33

4-
The following standard Python libraries are built in to MicroPython.
5-
6-
For additional libraries, please download them from the `micropython-lib repository
4+
This chapter described modules (function and class libraries) which are built
5+
into MicroPython. There are few categories of modules:
6+
7+
* Modules which implement subset of standard Python functionality and are not
8+
intended to be extended by a user.
9+
* Modules which are implement subset of Python functionality, with a provision
10+
for extension by a user (via Python code).
11+
* Modules which implement MicroPython extensions to Python standard libraries.
12+
* Modules specific to a particular port and thus not portable.
13+
14+
Note about the availability of modules and their contents: This documentation
15+
in general aspires to describe all modules and functions/classes which are
16+
implemented in MicroPython. However, MicroPython is highly configurable, and
17+
each port to a particular board/embedded system makes available only a subset
18+
of MicroPython libraries. For officially supported ports, there is an effort
19+
to either filter out non-applicable items, or mark individual descriptions
20+
with "Availability:" clauses describing which ports provide a given feature.
21+
With that in mind, please still be ready to a fact that some function/class
22+
in a module, or even entire module, described in this documentation, may be
23+
not available in a particular build of MicroPython on a particular board. The
24+
best place to find a general information of the availability/non-availability
25+
of a particular feature is "General Information" secton which contains
26+
information pertaining to a specific port.
27+
28+
Beyond the built-in libraries described in this documentation, many more
29+
modules from the Python standard library, as well as further MicroPython
30+
extensions to it, can be found in the `micropython-lib repository
731
<https://github.com/micropython/micropython-lib>`_.
832

933
Python standard libraries and micro-libraries

0 commit comments

Comments
 (0)
0