Skip to content

docs for busdevice inconistent parameter description #10725

@deshipu

Description

@deshipu

CircuitPython version and board name

10.0

Code/REPL

no code

Behavior

no behavior

Description

On the https://docs.circuitpython.org/en/latest/shared-bindings/adafruit_bus_device/spi_device/index.html#adafruit_bus_device.spi_device.SPIDevice page, the description of the class definition is:

classadafruit_bus_device.spi_device.SPIDevice(spi: busio.SPI, chip_select: digitalio.DigitalInOut | None = None, *, baudrate: int = 100000, polarity: int = 0, phase: int = 0, extra_clocks: int = 0)
but the description of the parameters is:

spi (SPI) – The SPI bus the device is on
chip_select (DigitalInOut) – The chip select pin object that implements the DigitalInOut API. None if a chip select pin is not being used.
cs_active_value (bool) – Set to true if your device requires CS to be active high. Defaults to false.
extra_clocks (int) – The minimum number of clock cycles to cycle the bus after CS is high. (Used for SD cards.)

there is no description of baudrate, polarity and phase, and there is cs_active_value parameter that doesn't exist in the class definition

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions