Skip to content

Commit a3c9320

Browse files
authored
Merge pull request #8453 from heygauri/doc-rotaryio.IncrementalEncoder
Update documentation for rotaryio.IncrementalEncoder
2 parents 744222a + fd4a612 commit a3c9320

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

shared-bindings/rotaryio/IncrementalEncoder.c

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,9 @@
3535
#include "shared-bindings/util.h"
3636

3737
//| class IncrementalEncoder:
38-
//| """IncrementalEncoder determines the relative rotational position based on two series of pulses."""
38+
//| """IncrementalEncoder determines the relative rotational position based on two series of pulses.
39+
//| It assumes that the encoder's common pin(s) are connected to ground,and enables pull-ups on
40+
//| pin_a and pin_b."""
3941
//|
4042
//| def __init__(
4143
//| self, pin_a: microcontroller.Pin, pin_b: microcontroller.Pin, divisor: int = 4

0 commit comments

Comments
 (0)