Did board, digitalio, displayio

Author: evaherrada

shared-bindings/board/__init__.c

@@ -29,7 +29,7 @@
 
 #include "shared-bindings/board/__init__.h"
 
-//| :mod:`board` --- Board specific pin names
+//| """:mod:`board` --- Board specific pin names
 //| ========================================================
 //|
 //| .. module:: board
@@ -39,11 +39,11 @@
 //| board so don't expect portability when using this module.
 //|
 //| .. 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."""
 
-//| .. function:: I2C()
-//|
-//|   Returns the `busio.I2C` object for the board designated SDA and SCL pins. It is a singleton.
+//| def I2C() -> Any:
+//|     """Returns the `busio.I2C` object for the board designated SDA and SCL pins. It is a singleton."""
+//|     ...
 //|
 
 #if BOARD_I2C
@@ -65,10 +65,10 @@ mp_obj_t board_i2c(void) {
 MP_DEFINE_CONST_FUN_OBJ_0(board_i2c_obj, board_i2c);
 
 
-//| .. function:: SPI()
-//|
-//|   Returns the `busio.SPI` object for the board designated SCK, MOSI and MISO pins. It is a
-//|   singleton.
+//| def SPI() -> Any:
+//|     """Returns the `busio.SPI` object for the board designated SCK, MOSI and MISO pins. It is a
+//|     singleton."""
+//|     ...
 //|
 #if BOARD_SPI
 mp_obj_t board_spi(void) {
@@ -89,15 +89,14 @@ mp_obj_t board_spi(void) {
 #endif
 MP_DEFINE_CONST_FUN_OBJ_0(board_spi_obj, board_spi);
 
-//| .. function:: UART()
-//|
-//|   Returns the `busio.UART` object for the board designated TX and RX pins. It is a singleton.
-//|
-//|   The object created uses the default parameter values for `busio.UART`. If you need to set
-//|   parameters that are not changeable after creation, such as ``receiver_buffer_size``,
-//|   do not use `board.UART()`; instead create a `busio.UART` object explicitly with the
-//|   desired parameters.
+//| def UART() -> Any:
+//|     """Returns the `busio.UART` object for the board designated TX and RX pins. It is a singleton.
 //|
+//|     The object created uses the default parameter values for `busio.UART`. If you need to set
+//|     parameters that are not changeable after creation, such as ``receiver_buffer_size``,
+//|     do not use `board.UART()`; instead create a `busio.UART` object explicitly with the
+//|     desired parameters."""
+//|     ...
 //|
 #if BOARD_UART
 mp_obj_t board_uart(void) {

shared-bindings/digitalio/DigitalInOut.c

@@ -43,23 +43,23 @@
 #include "shared-bindings/util.h"
 #include "supervisor/shared/translate.h"
 
-//| .. currentmodule:: digitalio
+//| class DigitalInOut:
+//|     """.. currentmodule:: digitalio
 //|
-//| :class:`DigitalInOut` -- digital input and output
-//| =========================================================
+//|     :class:`DigitalInOut` -- digital input and output
+//|     =========================================================
 //|
-//| A DigitalInOut is used to digitally control I/O pins. For analog control of
-//| a pin, see the :py:class:`analogio.AnalogIn` and
-//| :py:class:`analogio.AnalogOut` classes.
+//|     A DigitalInOut is used to digitally control I/O pins. For analog control of
+//|     a pin, see the :py:class:`analogio.AnalogIn` and
+//|     :py:class:`analogio.AnalogOut` classes."""
 //|
-
-//| .. class:: DigitalInOut(pin)
-//|
-//|   Create a new DigitalInOut object associated with the pin. Defaults to input
-//|   with no pull. Use :py:meth:`switch_to_input` and
-//|   :py:meth:`switch_to_output` to change the direction.
+//|     def __init__(self, pin: microcontroller.Pin):
+//|         """Create a new DigitalInOut object associated with the pin. Defaults to input
+//|         with no pull. Use :py:meth:`switch_to_input` and
+//|         :py:meth:`switch_to_output` to change the direction.
 //|
-//|   :param ~microcontroller.Pin pin: The pin to control
+//|         :param ~microcontroller.Pin pin: The pin to control"""
+//|         ...
 //|
 STATIC mp_obj_t digitalio_digitalinout_make_new(const mp_obj_type_t *type,
         mp_uint_t n_args, const mp_obj_t *args, mp_map_t *kw_args) {
@@ -74,9 +74,9 @@ STATIC mp_obj_t digitalio_digitalinout_make_new(const mp_obj_type_t *type,
     return MP_OBJ_FROM_PTR(self);
 }
 
-//|   .. method:: deinit()
-//|
-//|      Turn off the DigitalInOut and release the pin for other use.
+//|     def deinit(self, ) -> Any:
+//|         """Turn off the DigitalInOut and release the pin for other use."""
+//|         ...
 //|
 STATIC mp_obj_t digitalio_digitalinout_obj_deinit(mp_obj_t self_in) {
     digitalio_digitalinout_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -85,16 +85,16 @@ STATIC mp_obj_t digitalio_digitalinout_obj_deinit(mp_obj_t self_in) {
 }
 MP_DEFINE_CONST_FUN_OBJ_1(digitalio_digitalinout_deinit_obj, digitalio_digitalinout_obj_deinit);
 
-//|   .. method:: __enter__()
-//|
-//|      No-op used by Context Managers.
+//|     def __enter__(self, ) -> Any:
+//|         """No-op used by Context Managers."""
+//|         ...
 //|
 //  Provided by context manager helper.
 
-//|   .. method:: __exit__()
-//|
-//|      Automatically deinitializes the hardware when exiting a context. See
-//|      :ref:`lifetime-and-contextmanagers` for more info.
+//|     def __exit__(self, ) -> Any:
+//|         """Automatically deinitializes the hardware when exiting a context. See
+//|         :ref:`lifetime-and-contextmanagers` for more info."""
+//|         ...
 //|
 STATIC mp_obj_t digitalio_digitalinout_obj___exit__(size_t n_args, const mp_obj_t *args) {
     (void)n_args;
@@ -109,14 +109,13 @@ STATIC void check_for_deinit(digitalio_digitalinout_obj_t *self) {
     }
 }
 
+//|     def switch_to_output(self, value: bool = False, drive_mode: digitalio.DriveMode = digitalio.DriveMode.PUSH_PULL) -> Any:
+//|           """Set the drive mode and value and then switch to writing out digital
+//|           values.
 //|
-//|   .. method:: switch_to_output(value=False, drive_mode=digitalio.DriveMode.PUSH_PULL)
-//|
-//|       Set the drive mode and value and then switch to writing out digital
-//|       values.
-//|
-//|       :param bool value: default value to set upon switching
-//|       :param ~digitalio.DriveMode drive_mode: drive mode for the output
+//|           :param bool value: default value to set upon switching
+//|           :param ~digitalio.DriveMode drive_mode: drive mode for the output"""
+//|           ...
 //|
 STATIC mp_obj_t digitalio_digitalinout_switch_to_output(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_value, ARG_drive_mode };
@@ -139,22 +138,22 @@ STATIC mp_obj_t digitalio_digitalinout_switch_to_output(size_t n_args, const mp_
 }
 MP_DEFINE_CONST_FUN_OBJ_KW(digitalio_digitalinout_switch_to_output_obj, 1, digitalio_digitalinout_switch_to_output);
 
-//|   .. method:: switch_to_input(pull=None)
-//|
-//|     Set the pull and then switch to read in digital values.
+//|     def switch_to_input(self, pull: Pull = None) -> Any:
+//|         """Set the pull and then switch to read in digital values.
 //|
-//|     :param Pull pull: pull configuration for the input
+//|         :param Pull pull: pull configuration for the input
 //|
-//|     Example usage::
+//|         Example usage::
 //|
-//|       import digitalio
-//|       import board
+//|           import digitalio
+//|           import board
 //|
-//|       switch = digitalio.DigitalInOut(board.SLIDE_SWITCH)
-//|       switch.switch_to_input(pull=digitalio.Pull.UP)
-//|       # Or, after switch_to_input
-//|       switch.pull = digitalio.Pull.UP
-//|       print(switch.value)
+//|           switch = digitalio.DigitalInOut(board.SLIDE_SWITCH)
+//|           switch.switch_to_input(pull=digitalio.Pull.UP)
+//|           # Or, after switch_to_input
+//|           switch.pull = digitalio.Pull.UP
+//|           print(switch.value)"""
+//|         ...
 //|
 STATIC mp_obj_t digitalio_digitalinout_switch_to_input(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
     enum { ARG_pull };
@@ -178,14 +177,13 @@ STATIC mp_obj_t digitalio_digitalinout_switch_to_input(size_t n_args, const mp_o
 }
 MP_DEFINE_CONST_FUN_OBJ_KW(digitalio_digitalinout_switch_to_input_obj, 1, digitalio_digitalinout_switch_to_input);
 
-//|   .. attribute:: direction
-//|
-//|     The direction of the pin.
+//|     direction: Any = ...
+//|     """The direction of the pin.
 //|
 //|     Setting this will use the defaults from the corresponding
 //|     :py:meth:`switch_to_input` or :py:meth:`switch_to_output` method. If
 //|     you want to set pull, value or drive mode prior to switching, then use
-//|     those methods instead.
+//|     those methods instead."""
 //|
 typedef struct {
     mp_obj_base_t base;
@@ -225,9 +223,8 @@ const mp_obj_property_t digitalio_digitalio_direction_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. attribute:: value
-//|
-//|     The digital logic level of the pin.
+//|     value: Any = ...
+//|     """The digital logic level of the pin."""
 //|
 STATIC mp_obj_t digitalio_digitalinout_obj_get_value(mp_obj_t self_in) {
     digitalio_digitalinout_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -256,12 +253,11 @@ const mp_obj_property_t digitalio_digitalinout_value_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. attribute:: drive_mode
-//|
-//|     The pin drive mode. One of:
+//|     drive_mode: Any = ...
+//|     """The pin drive mode. One of:
 //|
 //|     - `digitalio.DriveMode.PUSH_PULL`
-//|     - `digitalio.DriveMode.OPEN_DRAIN`
+//|     - `digitalio.DriveMode.OPEN_DRAIN`"""
 //|
 STATIC mp_obj_t digitalio_digitalinout_obj_get_drive_mode(mp_obj_t self_in) {
     digitalio_digitalinout_obj_t *self = MP_OBJ_TO_PTR(self_in);
@@ -301,15 +297,14 @@ const mp_obj_property_t digitalio_digitalio_drive_mode_obj = {
               (mp_obj_t)&mp_const_none_obj},
 };
 
-//|   .. attribute:: pull
-//|
-//|     The pin pull direction. One of:
+//|     pull: Any = ...
+//|     """The pin pull direction. One of:
 //|
 //|     - `digitalio.Pull.UP`
 //|     - `digitalio.Pull.DOWN`
 //|     - `None`
 //|
-//|     :raises AttributeError: if `direction` is :py:data:`~digitalio.Direction.OUTPUT`.
+//|     :raises AttributeError: if `direction` is :py:data:`~digitalio.Direction.OUTPUT`."""
 //|
 STATIC mp_obj_t digitalio_digitalinout_obj_get_pull(mp_obj_t self_in) {
     digitalio_digitalinout_obj_t *self = MP_OBJ_TO_PTR(self_in);

shared-bindings/digitalio/Direction.c

@@ -38,23 +38,22 @@
 #include "shared-bindings/microcontroller/Pin.h"
 #include "shared-bindings/digitalio/DigitalInOut.h"
 
-//| .. currentmodule:: digitalio
+//| class Direction:
+//|     """.. currentmodule:: digitalio
 //|
-//| :class:`Direction` -- defines the direction of a digital pin
-//| =============================================================
+//|     :class:`Direction` -- defines the direction of a digital pin
+//|     ============================================================="""
 //|
-//| .. class:: Direction
+//|     def __init__(self, ):
+//|         """Enum-like class to define which direction the digital values are
+//|         going."""
+//|         ...
 //|
-//|     Enum-like class to define which direction the digital values are
-//|     going.
+//|     INPUT: Any = ...
+//|     """Read digital data in"""
 //|
-//|     .. data:: INPUT
-//|
-//|       Read digital data in
-//|
-//|     .. data:: OUTPUT
-//|
-//|       Write digital data out
+//|     OUTPUT: Any = ...
+//|     """Write digital data out"""
 //|
 const mp_obj_type_t digitalio_direction_type;
 

shared-bindings/digitalio/DriveMode.c

@@ -26,24 +26,23 @@
 
 #include "shared-bindings/digitalio/DriveMode.h"
 
-//| .. currentmodule:: digitalio
+//| class DriveMode:
+//|     """.. currentmodule:: digitalio
 //|
-//| :class:`DriveMode` -- defines the drive mode of a digital pin
-//| =============================================================
+//|     :class:`DriveMode` -- defines the drive mode of a digital pin
+//|     ============================================================="""
 //|
-//| .. class:: DriveMode
+//|     def __init__(self, ):
+//|         """Enum-like class to define the drive mode used when outputting
+//|         digital values."""
+//|         ...
 //|
-//|     Enum-like class to define the drive mode used when outputting
-//|     digital values.
+//|     PUSH_PULL: Any = ...
+//|     """Output both high and low digital values"""
 //|
-//|     .. data:: PUSH_PULL
-//|
-//|       Output both high and low digital values
-//|
-//|     .. data:: OPEN_DRAIN
-//|
-//|       Output low digital values but go into high z for digital high. This is
-//|       useful for i2c and other protocols that share a digital line.
+//|     OPEN_DRAIN: Any = ...
+//|     """Output low digital values but go into high z for digital high. This is
+//|     useful for i2c and other protocols that share a digital line."""
 //|
 const mp_obj_type_t digitalio_drive_mode_type;
 

shared-bindings/digitalio/Pull.c

@@ -26,25 +26,24 @@
 
 #include "shared-bindings/digitalio/Pull.h"
 
-//| .. currentmodule:: digitalio
+//| class Pull:
+//|     """.. currentmodule:: digitalio
 //|
-//| :class:`Pull` -- defines the pull of a digital input pin
-//| =============================================================
+//|     :class:`Pull` -- defines the pull of a digital input pin
+//|     ============================================================="""
 //|
-//| .. class:: Pull
+//|     def __init__(self, ):
+//|         """Enum-like class to define the pull value, if any, used while reading
+//|         digital values in."""
+//|         ...
 //|
-//|     Enum-like class to define the pull value, if any, used while reading
-//|     digital values in.
+//|     UP: Any = ...
+//|     """When the input line isn't being driven the pull up can pull the state
+//|     of the line high so it reads as true."""
 //|
-//|     .. data:: UP
-//|
-//|       When the input line isn't being driven the pull up can pull the state
-//|       of the line high so it reads as true.
-//|
-//|     .. data:: DOWN
-//|
-//|       When the input line isn't being driven the pull down can pull the
-//|       state of the line low so it reads as false.
+//|     DOWN: Any = ...
+//|     """When the input line isn't being driven the pull down can pull the
+//|     state of the line low so it reads as false."""
 //|
 const mp_obj_type_t digitalio_pull_type;
 

shared-bindings/digitalio/__init__.c

@@ -38,7 +38,7 @@
 
 #include "py/runtime.h"
 
-//| :mod:`digitalio` --- Basic digital pin support
+//| """:mod:`digitalio` --- Basic digital pin support
 //| =================================================
 //|
 //| .. module:: digitalio
@@ -86,7 +86,7 @@
 //|       led.value = True
 //|       time.sleep(0.1)
 //|       led.value = False
-//|       time.sleep(0.1)
+//|       time.sleep(0.1)"""
 //|
 
 STATIC const mp_rom_map_elem_t digitalio_module_globals_table[] = {