Merge pull request #97 from caternuson/doc_update

adafruit · Jun 27, 2024 · acc1daa · acc1daa
2 parents f806739 + 4e8764f
commit acc1daa
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/adafruit_ads1x15/analog_in.py b/adafruit_ads1x15/analog_in.py
@@ -49,7 +49,12 @@ def __init__(
 
     @property
     def value(self) -> int:
-        """Returns the value of an ADC pin as an integer."""
+        """The value on the analog pin between 0 and 65535
+        inclusive (16-bit). (read-only)
+
+        Even if the underlying analog to digital converter (ADC) is
+        lower resolution, the value is 16-bit.
+        """
         return self._ads.read(
             self._pin_setting, is_differential=self.is_differential
         ) << (16 - self._ads.bits)