Docs improvements

Author: rpavlik

adafruit_emc2101/__init__.py

@@ -21,9 +21,8 @@
 
 * Adafruit CircuitPython firmware for the supported boards:
   https://github.com/adafruit/circuitpython/releases
-
-# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
+* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 """
 
 from micropython import const
@@ -133,8 +132,13 @@ class SpinupTime(CV):
 
 
 class EMC2101:  # pylint: disable=too-many-instance-attributes
-    """Driver for the EMC2101 Fan Controller.
+    """Basic driver for the EMC2101 Fan Controller.
+
     :param ~busio.I2C i2c_bus: The I2C bus the EMC is connected to.
+
+    If you need control over PWM frequency and the controller's built in temperature/speed
+    look-up table (LUT), you will need :class:`emc2101_lut.EMC2101_LUT` which extends this
+    class to add those features, at the cost of increased memory usage.
     """
 
     _part_id = ROUnaryStruct(_REG_PARTID, "<B")
@@ -238,7 +242,12 @@ def manual_fan_speed(self, fan_speed):
     @property
     def lut_enabled(self):
         """Enable or disable the internal look up table used to map a given temperature
-        to a fan speed. When the LUT is disabled fan speed can be changed with `manual_fan_speed`"""
+        to a fan speed.
+
+        When the LUT is disabled (the default), fan speed can be changed with `manual_fan_speed`.
+        To actually set this to True and modify the LUT, you need to use the extended version of
+        this driver, :class:`emc2101_lut.EMC2101_LUT`
+        """
         return not self._fan_lut_prog
 
     @property

adafruit_emc2101/emc2101_lut.py

@@ -22,10 +22,10 @@
 * Adafruit CircuitPython firmware for the supported boards:
   https://github.com/adafruit/circuitpython/releases
 
-# * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
+* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
+* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 
-The class defined here may be used instead of adafruit_emc2101.EMC2101,
+The class defined here may be used instead of :class:`adafruit_emc2101.EMC2101`,
 if your device has enough RAM to support it. This class adds LUT control
 and PWM frequency control to the base feature set.
 """
@@ -56,7 +56,13 @@ def _speed_to_lsb(percentage):
 
 class FanSpeedLUT:
     """A class used to provide a dict-like interface to the EMC2101's Temperature to Fan speed
-    Look Up Table"""
+    Look Up Table.
+
+    Keys are integer temperatures, values are fan duty cycles between 0 and 100.
+    A max of 8 values may be stored.
+
+    To remove a single stored point in the LUT, assign it as `None`.
+    """
 
     # 8 (Temperature, Speed) pairs in increasing order
     _fan_lut = StructArray(_LUT_BASE, "<B", 16)
@@ -135,7 +141,10 @@ def _set_lut_entry(self, idx, temp, speed):
 
 
 class EMC2101_LUT(EMC2101):  # pylint: disable=too-many-instance-attributes
-    """Driver for the EMC2101 Fan Controller.
+    """Driver for the EMC2101 Fan Controller, with PWM frequency and LUT control.
+
+    See :class:`adafruit_emc2101.EMC2101` for the base/common functionality.
+
     :param ~busio.I2C i2c_bus: The I2C bus the EMC is connected to.
     """
 
@@ -221,5 +230,5 @@ def lut_enabled(self, enable_lut):
 
     @property
     def lut(self):
-        """The dict-like representation of the LUT"""
+        """The dict-like representation of the LUT, actually of type :class:`FanSpeedLUT`"""
         return self._lut

docs/examples.rst

@@ -11,6 +11,8 @@ LUT Usage Example
 -----------------
 
 Use the temperature to fan speed Look Up Table to automatically control the fan speed.
+This example requires more memory than the first one because it needs to use the extended
+:class:`adafruit_emc2101.emc2101_lut.EMC2101_LUT` driver to access LUT functionality.
 
 .. literalinclude:: ../examples/emc2101_lut_example.py
     :caption: examples/emc2101_lut_example.py
@@ -21,6 +23,8 @@ PWM Tuning
 -----------------
 
 Adjust the EMC2101s PWM settings to fit your application.
+This example requires more memory than the first one because it needs to use the extended
+:class:`adafruit_emc2101.emc2101_lut.EMC2101_LUT` driver to access LUT functionality.
 
 .. literalinclude:: ../examples/set_pwm_freq.py
     :caption: examples/set_pwm_freq.py