microbit-foundation / micropython-microbit-stubs

Type stubs for MicroPython for micro:bit to support the micro:bit Python Editor V3
https://python.microbit.org/
Other
3 stars 2 forks source link

Document classes that the user cannot instantiate #37

Open microbit-matt-hillsdon opened 2 years ago

microbit-matt-hillsdon commented 2 years ago

Button, the pins classes, the mem class in machine and probably others are all classes we need in the API docs but aren't intended for the user to create. Let's add some clear consistent documentation explaining this.

microbit-matt-hillsdon commented 2 years ago

uname_result is another example here of a class that only exists (in MicroPython at least) to document the structure of a return value. It's even less instantiable than the others.