Improve documentation

Author: jepler

adafruit_mcp2515/__init__.py

@@ -266,21 +266,7 @@ def _tx_buffer_status_decode(status_byte):
 
 
 class MCP2515:  # pylint:disable=too-many-instance-attributes
-    """A common shared-bus protocol."""
-
-    def __init__(
-        self,
-        spi_bus,
-        cs_pin,
-        *,
-        baudrate: int = 250000,
-        crystal_freq: Literal[8000000, 10000000, 16000000] = 16000000,
-        loopback: bool = False,
-        silent: bool = False,
-        auto_restart: bool = False,
-        debug: bool = False,
-    ):
-        """A common shared-bus protocol.
+    """A common shared-bus protocol.
 
         :param ~busio.SPI spi: The SPI bus used to communicate with the MCP2515
         :param ~digitalio.DigitalInOut cs_pin:  SPI bus enable pin
@@ -297,10 +283,22 @@ def __init__(
         :param bool auto_restart: **Not supported by hardware. An `AttributeError` will be raised\
         if `auto_restart` is set to `True`** If `True`, will restart communications after entering\
         bus-off state. Defaults to `False`.
-
         :param bool debug: If `True`, will enable printing debug information. Defaults to `False`.
         """
 
+    def __init__(
+        self,
+        spi_bus,
+        cs_pin,
+        *,
+        baudrate: int = 250000,
+        crystal_freq: Literal[8000000, 10000000, 16000000] = 16000000,
+        loopback: bool = False,
+        silent: bool = False,
+        auto_restart: bool = False,
+        debug: bool = False,
+    ):
+
         if loopback and not silent:
             raise AttributeError("Loopback mode requires silent to be set")
         if auto_restart:

adafruit_mcp2515/canio/__init__.py

@@ -8,18 +8,16 @@
 
 
 class Message:
-    """A class representing a CANbus data frame"""
+    """A class representing a CANbus data frame
+
+    :param int id: The numeric ID of the message
+    :param bytes data: The content of the message, from 0 to 8 bytes of data
+    :param bool extended: True if the message has an extended identifier,
+        False if it has a standard identifier
+    """
 
     # pylint:disable=too-many-arguments,invalid-name,redefined-builtin
     def __init__(self, id, data, extended=False):
-        """Create a `Message` to send
-
-        :param int id: The numeric ID of the message
-        :param bytes data: The content of the message, from 0 to 8 bytes of data
-        :param bool extended: True if the message has an extended identifier,
-            False if it has a standard identifier
-        """
-
         self._data = None
         self.id = id
         self.data = data
@@ -53,17 +51,15 @@ def data(self, new_data):
 
 
 class RemoteTransmissionRequest:
-    """A class representing a CANbus remote frame"""
+    """A class representing a CANbus remote frame
 
-    def __init__(self, id: int, length: int, *, extended: bool = False):
-        """Construct a RemoteTransmissionRequest to send on a CAN bus
+    :param int id: The numeric ID of the message
+    :param length int: The length of the requested message
+    :param bool extended: True if the message has an extended identifier,
+        False if it has a standard identifier
+    """
 
-        Args:
-        :param int id: The numeric ID of the message
-        :param length int: The length of the requested message
-        :param bool extended: True if the message has an extended identifier,
-            False if it has a standard identifier
-        """
+    def __init__(self, id: int, length: int, *, extended: bool = False):
         self.id = id
         self.length = length
         self.extended = extended
@@ -88,8 +84,8 @@ def __init__(self, id: int, length: int, *, extended: bool = False):
 class Listener:
     """Listens for a CAN message
 
-        canio.Listener is not constructed directly, but instead by calling the `listen` method of a\
-        canio.CAN object.
+    canio.Listener is not constructed directly, but instead by calling the
+    ``listen`` method of a canio.CAN object.
     """
 
     def __init__(self, can_bus_obj, timeout=1.0):