djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library: Clarify relation between machine and port-specific mods.

Browse Source
This commit is contained in:
Peter Hinch 2018-11-05 07:13:12 +00:00 committed by Damien George
parent 5463ab6df6
commit c0b3419261
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/library/index.rst
View File

@ -116,6 +116,19 @@ the following libraries.
uctypes.rst 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 Libraries specific to the pyboard
--------------------------------- ---------------------------------