Skip to content

Commit 2a88a27

Browse files
committed
Modify class docstring
1 parent f9c52e7 commit 2a88a27

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

adafruit_nunchuk.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,14 @@
4242

4343

4444
class Nunchuk:
45-
"""
46-
Class which provides interface to Nintendo Nunchuk controller.
45+
"""Class which provides interface to Nintendo Nunchuk controller.
4746
48-
:param i2c: The `busio.I2C` object to use.
49-
:param address: The I2C address of the device. Default is 0x52.
50-
:type address: int, optional
51-
:param i2c_read_delay: The time in seconds to pause between the
47+
:param ~I2C i2c: The `busio.I2C` object to use.
48+
:param int address: (Optional) The I2C address of the device. Default is 0x52.
49+
:param float i2c_read_delay: (Optional) The time in seconds to pause between the
5250
I2C write and read. This needs to be at least 200us. A
5351
conservative default of 2000us is used since some hosts may
5452
not be able to achieve such timing.
55-
:type i2c_read_delay: float, optional
5653
"""
5754

5855
_Values = namedtuple("Values", ("joystick", "buttons", "acceleration"))

0 commit comments

Comments
 (0)