add board_id to the board module documentation

This commit is contained in:
Neradoc 2021-09-30 19:18:11 +02:00
parent fab27f6be6
commit ab65e88a87

View File

@ -43,6 +43,12 @@
//| .. warning:: The board module varies by board. The APIs documented here may or may not be //| .. warning:: The board module varies by board. The APIs documented here may or may not be
//| available on a specific board.""" //| available on a specific board."""
//| board_id: str
//| """Board ID string. The unique identifier for the board model in
//| circuitpython, as well as on circuitpython.org.
//| Example: "hallowing_m0_express"."""
//|
//| def I2C() -> busio.I2C: //| def I2C() -> busio.I2C:
//| """Returns the `busio.I2C` object for the board designated SDA and SCL pins. It is a singleton.""" //| """Returns the `busio.I2C` object for the board designated SDA and SCL pins. It is a singleton."""
//| ... //| ...