Skip to content

Commit 65ce2a6

Browse files
committed
Fix documentation
1 parent 4ef9748 commit 65ce2a6

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

adafruit_ads1x15/ads1x15.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,8 @@ def mode(self, mode: Mode):
126126
def read(self, pin: Pin, is_differential: bool = False) -> int:
127127
"""I2C Interface for ADS1x15-based ADCs reads.
128128
129-
params:
130-
:param pin: individual or differential pin.
131-
:param bool is_differential: single-ended or differential read.
129+
:param ~microcontroller.Pin pin: individual or differential pin.
130+
:param bool is_differential: single-ended or differential read.
132131
"""
133132
pin = pin if is_differential else pin + 0x04
134133
return self._read(pin)

adafruit_ads1x15/analog_in.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,16 @@
2222

2323

2424
class AnalogIn:
25-
"""AnalogIn Mock Implementation for ADC Reads."""
25+
"""AnalogIn Mock Implementation for ADC Reads.
26+
27+
:param ADS1x15 ads: The ads object.
28+
:param int positive_pin: Required pin for single-ended.
29+
:param int negative_pin: Optional pin for differential reads.
30+
"""
2631

2732
def __init__(
2833
self, ads: ADS1x15, positive_pin: int, negative_pin: Optional[int] = None
2934
):
30-
"""AnalogIn
31-
32-
:param ads: The ads object.
33-
:param ~digitalio.DigitalInOut positive_pin: Required pin for single-ended.
34-
:param ~digitalio.DigitalInOut negative_pin: Optional pin for differential reads.
35-
"""
3635
self._ads = ads
3736
self._pin_setting = positive_pin
3837
self._negative_pin = negative_pin

0 commit comments

Comments
 (0)