Update documentation for rotaryio.IncrementalEncoder

heygauri · heygauri · commit fd4a61233e9f · 2023-10-02T21:18:55.000+05:30
Update the documentation in circuitpython/shared-bindings/rotaryio/IncrementalEncoder.c to explicitly state that rotaryio.IncrementalEncoder assumes the encoder's pins are connected to ground and sets pull-ups on the pins accordingly. Closes adafruit#5847 Signed-off-by: Sumitra Sharma <sumitraartsy@gmail.com>
diff --git a/shared-bindings/rotaryio/IncrementalEncoder.c b/shared-bindings/rotaryio/IncrementalEncoder.c
@@ -35,7 +35,9 @@
 #include "shared-bindings/util.h"
 
 //| class IncrementalEncoder:
-//|     """IncrementalEncoder determines the relative rotational position based on two series of pulses."""
+//|     """IncrementalEncoder determines the relative rotational position based on two series of pulses.
+//|	   It assumes that the encoder's common pin(s) are connected to ground,and enables pull-ups on
+//|	   pin_a and pin_b."""
 //|
 //|     def __init__(
 //|         self, pin_a: microcontroller.Pin, pin_b: microcontroller.Pin, divisor: int = 4
