Skip to content

Commit a6ef2ae

Browse files
authored
Merge pull request #5416 from Neradoc/add-board-id-doc
Add board_id to the board module documentation
2 parents fab27f6 + ab65e88 commit a6ef2ae

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

shared-bindings/board/__init__.c

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@
4343
//| .. warning:: The board module varies by board. The APIs documented here may or may not be
4444
//| available on a specific board."""
4545

46+
//| board_id: str
47+
//| """Board ID string. The unique identifier for the board model in
48+
//| circuitpython, as well as on circuitpython.org.
49+
//| Example: "hallowing_m0_express"."""
50+
//|
51+
4652
//| def I2C() -> busio.I2C:
4753
//| """Returns the `busio.I2C` object for the board designated SDA and SCL pins. It is a singleton."""
4854
//| ...

0 commit comments

Comments
 (0)