Skip to content

Commit

Permalink
fix function headers and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jfurcean committed Feb 8, 2021
1 parent b62b447 commit d4a6a86
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 13 deletions.
15 changes: 15 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,18 @@
.. automodule:: wiichuck
:members:

.. automodule:: wiichuck.classic_controller
:members:

.. automodule:: wiichuck.nunchuk
:members:

.. automodule:: wiichuck.dj_table
:members:

.. automodule:: wiichuck.guitar
:members:

.. automodule:: wiichuck.udraw
:members:
2 changes: 1 addition & 1 deletion wiichuck/classic_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ def dpad(self):

@property
def triggers(self):
"""The current accelerometer reading."""
"""The current readding from the triggers (0-31 for Pro) (0 or 31 non-Pro)."""
return self._triggers()

def _joysticks(self, do_read=True):
Expand Down
10 changes: 5 additions & 5 deletions wiichuck/dj_table.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,27 +80,27 @@ def values(self):

@property
def joystick(self):
"""The current joystick positions."""
"""The current joystick position."""
return self._joystick()

@property
def buttons(self):
"""The current pressed state of all buttons."""
"""The current pressed state of all buttons that are not on the turntable."""
return self._buttons()

@property
def turntables(self):
"""The current pressed state of the dpad."""
"""The current reading from the turntable and it's buttons."""
return self._turntables()

@property
def dial(self):
"""The current accelerometer reading."""
"""The current dial position."""
return self._dial()

@property
def slider(self):
"""The current accelerometer reading."""
"""The current slider position."""
return self._slider()

def _joystick(self, do_read=True):
Expand Down
8 changes: 4 additions & 4 deletions wiichuck/guitar.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ def values(self):

@property
def joystick(self):
"""The current joystick positions."""
"""The current joystick position."""
return self._joystick()

@property
Expand All @@ -93,17 +93,17 @@ def buttons(self):

@property
def strum(self):
"""The current pressed state of the dpad."""
"""The current pressed state of strum.up and strum.down."""
return self._strum()

@property
def whammy(self):
"""The current accelerometer reading."""
"""The current whammy position."""
return self._whammy()

@property
def touchbar(self):
"""The current accelerometer reading."""
"""The current touchbar position. Only available in the Guitar Hero World Tour Guitars"""
return self._touchbar()

def _joystick(self, do_read=True):
Expand Down
2 changes: 1 addition & 1 deletion wiichuck/nunchuk.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# SPDX-License-Identifier: MIT

"""
`wiichuck.nunchuck`
`wiichuck.nunchuk`
================================================================================
CircuitPython driver for Nintento WiiMote I2C Accessory Devices
Expand Down
4 changes: 2 additions & 2 deletions wiichuck/udraw.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def values(self):

@property
def position(self):
"""The current joystick position."""
"""The current pen tip position."""
return self._position()

@property
Expand All @@ -77,7 +77,7 @@ def buttons(self):

@property
def pressure(self):
"""The current accelerometer reading."""
"""The current pressure reading."""
return self._pressure()

def _position(self, do_read=True):
Expand Down

0 comments on commit d4a6a86

Please sign in to comment.