polishing docs

Author: siddacious

.gitignore

@@ -9,4 +9,5 @@ bundles
 *.DS_Store
 .eggs
 dist
-**/*.egg-info
+**/*.egg-info
+.vscode

README.rst

@@ -22,6 +22,7 @@ This driver depends on:
 
 * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
 * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
+* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
 
 Please ensure all dependencies are available on the CircuitPython filesystem.
 This is easily achieved by downloading

adafruit_lsm303agr_mag.py

@@ -44,6 +44,8 @@
   https://circuitpython.org/downloads
 * Adafruit's Bus Device library:
   https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+* Adafruit's Register library:
+  https://github.com/adafruit/Adafruit_CircuitPython_Register
 """
 
 from time import sleep
@@ -65,10 +67,14 @@
 
 class DataRate: # pylint: disable=too-few-public-methods
     """Data rate choices to set using `data_rate`"""
-    Rate_10_HZ   = const(0x00)  # 10 Hz
-    Rate_20_HZ   = const(0x01)  # 20 Hz
-    Rate_50_HZ   = const(0x02)  # 50 Hz
-    Rate_100_HZ  = const(0x03)  # 100 Hz
+    Rate_10_HZ   = const(0x00)
+    """10 Hz"""
+    Rate_20_HZ   = const(0x01)
+    """20 Hz"""
+    Rate_50_HZ   = const(0x02)
+    """50 Hz"""
+    Rate_100_HZ  = const(0x03)
+    """100 Hz"""
 
 
 # Magnetometer registers
@@ -98,7 +104,12 @@ class DataRate: # pylint: disable=too-few-public-methods
 _MAG_SCALE = 0.15 # 1.5 milligauss/LSB * 0.1 microtesla/milligauss
 
 class LSM303AGR_Mag:# pylint: disable=too-many-instance-attributes
-    """Driver for the LSM303AGR's 'magnetometer."""
+    """
+    Driver for the Driver for the LSM303AGR's 'magnetometer.
+
+    :param busio.I2C i2c_bus: The I2C bus the LSM303AGR is connected to.
+
+    """
     _BUFFER = bytearray(6)
 
     _device_id = ROUnaryStruct(WHO_AM_I, "B")
@@ -163,7 +174,7 @@ def reset(self):
         self._interrupt_pin_putput = True
         self._temp_comp = True
 
-        sleep(0.020) # sleep 20ms to allow measurements to stabilize
+        sleep(0.030) # sleep 20ms to allow measurements to stabilize
 
     @property
     def magnetic(self):

examples/lsm303agr_mag_interrupt.py

@@ -17,4 +17,4 @@
     print("Int triggered: %s"%int_triggered)
     print()
 
-    time.sleep(1)
+    time.sleep(1)

requirements.txt

@@ -1,2 +1,3 @@
 Adafruit-Blinka
 adafruit-circuitpython-busdevice
+adafruit-circuitpython-register

setup.py

@@ -34,7 +34,7 @@
     author='Adafruit Industries',
     author_email='[email protected]',
 
-    install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice'],
+    install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice', 'adafruit-circuitpython-register'],
 
     # Choose your license
     license='MIT',