Skip to content

missing blank line in adafruit_bus_device docs #4927

@2bndy5

Description

@2bndy5

//| Represents a single SPI device and manages locking the bus and the device address.
//| :param ~busio.SPI spi: The SPI bus the device is on

//| address.
//| :param ~busio.I2C i2c: The I2C bus the device is on

The first :param: directive needs to be preceded by a blank line. Currently (see above snippets), the parameters are all clumped into 1 paragraph.

I also noticed the busio docs still link to the pure python package's docs. To link to circuitpython's docs, (I think) it would be as easy as removing a intersphinx mapping from the conf.py file.

ps - If not all boards have adafruit_bus_device, it would be nice to see which boards (in the module support matrix) have adafruit_bus_device builtin. However, that might be a more complicated solution given that the matrix seems to be generated with a py script (I think). So, that should probably be a separate issue.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions