From d4a6a869ef5787ccd3c023d421fd71f6f72226dd Mon Sep 17 00:00:00 2001
From: John Furcean <furceanj@msu.edu>
Date: Mon, 8 Feb 2021 13:05:38 -0500
Subject: [PATCH] fix function headers and documentation

---
 docs/api.rst                   | 15 +++++++++++++++
 wiichuck/classic_controller.py |  2 +-
 wiichuck/dj_table.py           | 10 +++++-----
 wiichuck/guitar.py             |  8 ++++----
 wiichuck/nunchuk.py            |  2 +-
 wiichuck/udraw.py              |  4 ++--
 6 files changed, 28 insertions(+), 13 deletions(-)

diff --git a/docs/api.rst b/docs/api.rst
index 9fbdb22..9053df2 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -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:
diff --git a/wiichuck/classic_controller.py b/wiichuck/classic_controller.py
index 48bf268..b5db5b7 100644
--- a/wiichuck/classic_controller.py
+++ b/wiichuck/classic_controller.py
@@ -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):
diff --git a/wiichuck/dj_table.py b/wiichuck/dj_table.py
index 5f7c2b8..27a0653 100644
--- a/wiichuck/dj_table.py
+++ b/wiichuck/dj_table.py
@@ -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):
diff --git a/wiichuck/guitar.py b/wiichuck/guitar.py
index b1bcaaa..21aa96b 100644
--- a/wiichuck/guitar.py
+++ b/wiichuck/guitar.py
@@ -83,7 +83,7 @@ def values(self):
 
     @property
     def joystick(self):
-        """The current joystick positions."""
+        """The current joystick position."""
         return self._joystick()
 
     @property
@@ -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):
diff --git a/wiichuck/nunchuk.py b/wiichuck/nunchuk.py
index 3a84721..e941289 100644
--- a/wiichuck/nunchuk.py
+++ b/wiichuck/nunchuk.py
@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: MIT
 
 """
-`wiichuck.nunchuck`
+`wiichuck.nunchuk`
 ================================================================================
 
 CircuitPython driver for Nintento WiiMote I2C Accessory Devices
diff --git a/wiichuck/udraw.py b/wiichuck/udraw.py
index 26f9057..5888d45 100644
--- a/wiichuck/udraw.py
+++ b/wiichuck/udraw.py
@@ -67,7 +67,7 @@ def values(self):
 
     @property
     def position(self):
-        """The current joystick position."""
+        """The current pen tip position."""
         return self._position()
 
     @property
@@ -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):