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

apply suggestions from reviews

Browse Source 
- minor typo fix
- update documentation for board module
This commit is contained in:
microDev 2021-12-15 02:00:20 +05:30
parent 5939c11406
commit 96c6271134
No known key found for this signature in database
GPG Key ID: 2C0867BE60967730
2 changed files with 12 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
shared-bindings/board/__init__.c
View File

@ -65,8 +65,9 @@ STATIC mp_int_t board_get_instance(size_t n_args, const mp_obj_t *args, const mp
#endif #endif
//| def I2C(instance: Optional[int] = 0) -> busio.I2C: //| def I2C(instance: Optional[int] = 0) -> busio.I2C:
//| """Returns the `busio.I2C` object for the board's designated I2C bus(es). It is a singleton. //| """Returns the `busio.I2C` object for the board's designated I2C bus(es).
//| The object created uses the default parameter values for `busio.I2C`.""" //| If there is more than one default I2C bus, the buses are numbered starting at 0.
//| The object created is a singleton, and uses the default parameter values for `busio.I2C`."""
//| ... //| ...
//| //|
#if CIRCUITPY_BOARD_I2C #if CIRCUITPY_BOARD_I2C
@ -87,8 +88,9 @@ mp_obj_t board_i2c(size_t n_args, const mp_obj_t *args) {
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(board_i2c_obj, 0, 1, board_i2c); MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(board_i2c_obj, 0, 1, board_i2c);
//| def SPI(instance: Optional[int] = 0) -> busio.SPI: //| def SPI(instance: Optional[int] = 0) -> busio.SPI:
//| """Returns the `busio.SPI` object for the board's designated SPI bus(es). It is a singleton. //| """Returns the `busio.SPI` object for the board's designated SPI bus(es).
//| The object created uses the default parameter values for `busio.SPI`.""" //| If there is more than one default SPI bus, the buses are numbered starting at 0.
//| The object created is a singleton, and uses the default parameter values for `busio.SPI`."""
//| ... //| ...
//| //|
#if CIRCUITPY_BOARD_SPI #if CIRCUITPY_BOARD_SPI
@ -109,8 +111,9 @@ mp_obj_t board_spi(size_t n_args, const mp_obj_t *args) {
MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(board_spi_obj, 0, 1, board_spi); MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(board_spi_obj, 0, 1, board_spi);
//| def UART(instance: Optional[int] = 0) -> busio.UART: //| def UART(instance: Optional[int] = 0) -> busio.UART:
//| """Returns the `busio.UART` object for the board's designated UART bus(es). It is a singleton. //| """Returns the `busio.UART` object for the board's designated UART bus(es).
//| The object created uses the default parameter values for `busio.UART`.""" //| If there is more than one default UART bus, the buses are numbered starting at 0.
//| The object created is a singleton, and uses the default parameter values for `busio.UART`."""
//| ... //| ...
//| //|
#if CIRCUITPY_BOARD_UART #if CIRCUITPY_BOARD_UART

6
shared-bindings/board/__init__.h
View File

@ -36,19 +36,19 @@ extern const mp_obj_dict_t board_module_globals;
STATIC const MP_DEFINE_STR_OBJ(board_module_id_obj, CIRCUITPY_BOARD_ID); STATIC const MP_DEFINE_STR_OBJ(board_module_id_obj, CIRCUITPY_BOARD_ID);
bool common_hal_board_is_i2c(mp_obj_t obj); bool common_hal_board_is_i2c(mp_obj_t obj);
mp_obj_t common_hal_board_get_i2c(const mp_int_t insatnce); mp_obj_t common_hal_board_get_i2c(const mp_int_t instance);
mp_obj_t common_hal_board_create_i2c(const mp_int_t instance); mp_obj_t common_hal_board_create_i2c(const mp_int_t instance);
mp_obj_t board_i2c(size_t n_args, const mp_obj_t *args); mp_obj_t board_i2c(size_t n_args, const mp_obj_t *args);
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(board_i2c_obj); MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(board_i2c_obj);
bool common_hal_board_is_spi(mp_obj_t obj); bool common_hal_board_is_spi(mp_obj_t obj);
mp_obj_t common_hal_board_get_spi(const mp_int_t insatnce); mp_obj_t common_hal_board_get_spi(const mp_int_t instance);
mp_obj_t common_hal_board_create_spi(const mp_int_t instance); mp_obj_t common_hal_board_create_spi(const mp_int_t instance);
mp_obj_t board_spi(size_t n_args, const mp_obj_t *args); mp_obj_t board_spi(size_t n_args, const mp_obj_t *args);
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(board_spi_obj); MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(board_spi_obj);
bool common_hal_board_is_uart(mp_obj_t obj); bool common_hal_board_is_uart(mp_obj_t obj);
mp_obj_t common_hal_board_get_uart(const mp_int_t insatnce); mp_obj_t common_hal_board_get_uart(const mp_int_t instance);
mp_obj_t common_hal_board_create_uart(const mp_int_t instance); mp_obj_t common_hal_board_create_uart(const mp_int_t instance);
mp_obj_t board_uart(size_t n_args, const mp_obj_t *args); mp_obj_t board_uart(size_t n_args, const mp_obj_t *args);
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(board_uart_obj); MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(board_uart_obj);