diff options
| author | Peter Hinch <peter@hinch.me.uk> | 2018-11-05 07:13:12 +0000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2019-10-16 14:03:44 +1100 |
| commit | c0b3419261a7fa373d9d6f07d4bef55d019d52b9 (patch) | |
| tree | b27d03d6540fe803bda491e39d38dd56194982af /docs/library/index.rst | |
| parent | 5463ab6df6243a63a88f686113e408933956b8eb (diff) | |
| download | micropython-c0b3419261a7fa373d9d6f07d4bef55d019d52b9.tar.gz micropython-c0b3419261a7fa373d9d6f07d4bef55d019d52b9.zip | |
docs/library: Clarify relation between machine and port-specific mods.
Diffstat (limited to 'docs/library/index.rst')
| -rw-r--r-- | docs/library/index.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst index 7d4bb872cf..dc89766e2d 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -116,6 +116,19 @@ the following libraries. uctypes.rst +Port-specific libraries +----------------------- + +In some cases the following port/board-specific libraries have functions or +classes similar to those in the :mod:`machine` library. Where this occurs, the +entry in the port specific library exposes hardware functionality unique to +that platform. + +To write portable code use functions and classes from the :mod:`machine` module. +To access platform-specific hardware use the appropriate library, e.g. +:mod:`pyb` in the case of the Pyboard. + + Libraries specific to the pyboard --------------------------------- |