1 parent e9b7610 commit fd283ebCopy full SHA for fd283eb
1 file changed
docs/library/sys.rst
@@ -88,9 +88,12 @@ Constants
88
89
.. data:: platform
90
91
- The platform that MicroPython is running on. This is "pyboard" on the
92
- pyboard and provides a robust way of determining if a script is running
93
- on the pyboard or not.
+ The platform that MicroPython is running on. For OS/RTOS ports, this is
+ usually an identifier of the OS, e.g. ``"linux"``. For baremetal ports it
+ is an identifier of a board, e.g. "pyboard" for the original MicroPython
94
+ reference board. It thus can be used to distinguish one board from another.
95
+ If you need to check whether your program runs on MicroPython (vs other
96
+ Python implementation), use ``sys.implementation`` instead.
97
98
.. data:: stderr
99
0 commit comments