linted and docs updated

Author: siddacious

README.rst

@@ -31,11 +31,6 @@ This is easily achieved by downloading
 
 Installing from PyPI
 =====================
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
-   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-lsm6dsox/>`_. To install for current user:
@@ -61,8 +56,22 @@ To install in a virtual environment in your current project:
 
 Usage Example
 =============
+.. code-block:: python
+
+    import time
+    import board
+    import busio
+    import adafruit_lsm6dsox
+
+    i2c = busio.I2C(board.SCL, board.SDA)
+
+    sox = adafruit_lsm6dsox.LSM6DSOX(i2c)
 
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+    while True:
+        print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2"%(sox.acceleration))
+        print("Gyro X:%.2f, Y: %.2f, Z: %.2f degrees/s"%(sox.gyro))
+        print("")
+        time.sleep(0.5)
 
 Contributing
 ============

adafruit_debug_i2c.py

@@ -33,7 +33,7 @@
 
 **Hardware:**
 
-* `Adafruit LSM6DSOX Breakout https://www.adafruit.com/products/4438`_
+* Adafruit LSM6DSOX Breakout <https://www.adafruit.com/products/4438>
 
 
 **Software and Dependencies:**
@@ -111,7 +111,7 @@ def is_valid(cls, value):
         return value in cls.string
 
 class AccelRange(CV):
-    """Options for `accelerometer_range`"""
+    """Options for ``accelerometer_range``"""
     pass #pylint: disable=unnecessary-pass
 
 AccelRange.add_values((
@@ -122,7 +122,7 @@ class AccelRange(CV):
 ))
 
 class GyroRange(CV):
-    """Options for `gyro_data_range`"""
+    """Options for ``gyro_data_range``"""
     pass #pylint: disable=unnecessary-pass
 
 GyroRange.add_values((
@@ -133,7 +133,7 @@ class GyroRange(CV):
 ))
 
 class Rate(CV):
-    """Options for `data_rate`"""
+    """Options for ``accelerometer_data_rate`` and ``gyro_data_rate``"""
     pass #pylint: disable=unnecessary-pass
 
 Rate.add_values((
@@ -239,7 +239,7 @@ def reset(self):
 
     @property
     def acceleration(self):
-        """Acceleration!"""
+        """The x, y, z acceleration values returned in a 3-tuple and are in m / s ^ 2."""
         raw_accel_data = self._raw_accel_data
         x = self._scale_xl_data(raw_accel_data[0])
         y = self._scale_xl_data(raw_accel_data[1])
@@ -249,7 +249,7 @@ def acceleration(self):
 
     @property
     def gyro(self):
-        """ME GRYO, ME FLY PLANE"""
+        """The x, y, z angular velocity values returned in a 3-tuple and are in degrees / second"""
         raw_gyro_data = self._raw_gyro_data
         x = self._scale_gyro_data(raw_gyro_data[0])
         y = self._scale_gyro_data(raw_gyro_data[1])

adafruit_lsm6dsox.py

@@ -20,17 +20,11 @@ Table of Contents
 
     api
 
-.. toctree::
-    :caption: Tutorials
-
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+    Adafruit LSM6DSOX Breakout <https://www.adafruit.com/products/4438>
+
 
 .. toctree::
     :caption: Other Links

docs/index.rst

@@ -1,8 +1,7 @@
-import time
 import board
 import busio
 from adafruit_lsm6dsox import LSM6DSOX, Rate, AccelRange, GyroRange
-
+#pylint:disable=no-member
 i2c = busio.I2C(board.SCL, board.SDA)
 sox = LSM6DSOX(i2c)
 
@@ -20,4 +19,4 @@
 
 while True:
     print("Accel X:%.2f Y:%.2f Z:%.2f ms^2 Gyro X:%.2f Y:%.2f Z:%.2f degrees/s"%
-        (sox.acceleration+sox.gyro))
+          (sox.acceleration+sox.gyro))

examples/lsm6dsox_full_test.py

@@ -1,11 +1,9 @@
-import time
 import board
 import busio
 import adafruit_lsm6dsox
-from adafruit_debug_i2c import DebugI2C
+#pylint:disable=no-member
 
 i2c = busio.I2C(board.SCL, board.SDA)
-# i2c = DebugI2C(busio.I2C(board.SCL, board.SDA))
 
 sox = adafruit_lsm6dsox.LSM6DSOX(i2c)
 

examples/lsm6dsox_rate_test.py

@@ -11,4 +11,4 @@
     print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2"%(sox.acceleration))
     print("Gyro X:%.2f, Y: %.2f, Z: %.2f degrees/s"%(sox.gyro))
     print("")
-    time.sleep(0.5)
+    time.sleep(0.5)