From 54320096fb9d23d152ec86a0b9c42bd413ae5bcd Mon Sep 17 00:00:00 2001 From: Konstantin Lampalzer Date: Sun, 12 Sep 2021 13:54:38 +0200 Subject: [PATCH] Documentation --- compLib/Encoder.py | 6 +++--- docs/source/conf.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/compLib/Encoder.py b/compLib/Encoder.py index 75ac3a0..d6ef934 100644 --- a/compLib/Encoder.py +++ b/compLib/Encoder.py @@ -18,7 +18,7 @@ class Encoder(object): def read_raw(port: int) -> int: """Read raw encoder from a specified port. Will not be reset to 0 at start. - :param port: Port, which the motor is connected to. 1-4 allowed + :param port: Port, which the motor is connected to. Between 1 and 4 :raises: IndexError :return: Current encoder position """ @@ -38,7 +38,7 @@ class Encoder(object): def read(port: int) -> int: """Read encoder from a specified port - :param port: Port, which the motor is connected to. 1-4 allowed + :param port: Port, which the motor is connected to. Between 1 and 4 :raises: IndexError :return: Current encoder position """ @@ -56,7 +56,7 @@ class Encoder(object): def clear(port: int): """Reset encoder position to 0 - :param port: Port, which the motor is connected to. 1-4 allowed + :param port: Port, which the motor is connected to. Between 1 and 4 :raises: IndexError """ if port <= 0 or port > MOTOR_COUNT: diff --git a/docs/source/conf.py b/docs/source/conf.py index 5c77524..60cd842 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -35,7 +35,7 @@ extensions = [ 'sphinx_rtd_theme' ] -autodoc_mock_imports = ["smbus", "compLib.PCA9685", "RPi", "pigpio", "flask", "apt", "spidev"] +autodoc_mock_imports = ["smbus", "compLib.PCA9685", "RPi", "pigpio", "flask", "apt", "spidev", "influxdb_client"] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']