Skip to content

Proposed docstring corrections #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 5, 2023
Merged

Proposed docstring corrections #77

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions adafruit_lis3dh.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@ class LIS3DH:
"""Driver base for the LIS3DH accelerometer.

:param digitalio.DigitalInOut int1: `digitalio.DigitalInOut` connected to
the LIS3DH INT1 interrupt pin
the LIS3DH INT interrupt pin
:param digitalio.DigitalInOut int2: `digitalio.DigitalInOut` connected to
the LIS3DH INT2 interrupt pin
the LIS3DH I2 interrupt pin (only on STEMMA QT model)
"""

def __init__(
Expand Down Expand Up @@ -440,9 +440,8 @@ def _write_register_byte(self, register: int, value: int) -> None:
class LIS3DH_SPI(LIS3DH):
"""Driver for the LIS3DH accelerometer connected over SPI.

:param ~busio.I2C i2c: The I2C bus the LIS3DH is connected to.
:param address: The I2C device address. Defaults to :const:`0x18`

:param ~busio.SPI spi: The SPI bus the LIS3DH is connected to.
:param digitalio.DigitalInOut cs: The pin connected to the LIS3DH CS pin

**Quickstart: Importing and using the device**

Expand All @@ -458,8 +457,9 @@ class LIS3DH_SPI(LIS3DH):

.. code-block:: python

i2c = board.SPI()
lis3dh = adafruit_lis3dh.LIS3DH_SPI(spi)
spi = board.SPI()
cs = digitalio.DigitalInOut(board.D5) # Set to correct CS pin!
lis3dh = adafruit_lis3dh.LIS3DH_SPI(spi, cs)

Now you have access to the :attr:`acceleration` attribute

Expand Down