Skip to content

Commit 46583e9

Browse files
committed
docs/glossary: Elaborate on possible MicroPython port differences.
State that this doc describes generic, "core" MicroPython functionality, any particular port may diverge in both directions, by both omitting some functionality, and adding more, both cases described outside the generic documentation.
1 parent 3f91570 commit 46583e9

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

docs/reference/glossary.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,13 @@ Glossary
6868
MicroPython supports different :term:`boards <board>`, RTOSes,
6969
and OSes, and can be relatively easily adapted to new systems.
7070
MicroPython with support for a particular system is called a
71-
"port" to that system.
71+
"port" to that system. Different ports may have widely different
72+
functionality. This documentation is intended to be a reference
73+
of the generic APIs available across different ports ("MicroPython
74+
core"). Note that some ports may still omit some APIs described
75+
here (e.g. due to resource constraints). Any such differences,
76+
and port-specific extensions beyond MicroPython core functionality,
77+
would be described in the separate port-specific documentation.
7278

7379
MicroPython Unix port
7480
Unix port is one of the major :term:`MicroPython ports <MicroPython port>`.

0 commit comments

Comments
 (0)