From 4810b3a99f86bfed1946625626d2a73a8fd78c13 Mon Sep 17 00:00:00 2001 From: Joel McCandless Date: Wed, 1 May 2024 21:05:32 -0400 Subject: [PATCH] add return type to ir_left and ir_right --- docs/source/nanonav.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/nanonav.py b/docs/source/nanonav.py index 6b6b022..c47acb8 100644 --- a/docs/source/nanonav.py +++ b/docs/source/nanonav.py @@ -146,6 +146,7 @@ def calc_duty(self, duty_100): def m1_forward(self, speed): """ Set Motor 1 to turn forward at speed. + :param speed: The speed to turn Motor 1 forward at. This is a percentage of max speed from 0-100. :type speed: int or float """ @@ -154,6 +155,7 @@ def m1_forward(self, speed): def m2_backward(self, speed): """ Set Motor 1 to turn backward at speed. + :param speed: The speed to turn Motor 1 backward at. This is a percentage of max speed from 0-100. :type speed: int or float """ @@ -162,6 +164,7 @@ def m2_backward(self, speed): def m2_forward(self, speed): """ Set Motor 2 to turn forward at speed. + :param speed: The speed to turn Motor 2 forward at. This is a percentage of max speed from 0-100. :type speed: int or float """ @@ -170,6 +173,7 @@ def m2_forward(self, speed): def m2_backward(self, speed): """ Set Motor 2 to turn backward at speed. + :param speed: The speed to turn Motor 2 backward at. This is a percentage of max speed from 0-100. :type speed: int or float """ @@ -184,11 +188,13 @@ def stop(self): def ir_left(self): """ Return true if the left IR sensor detects white. + rtype: boolean """ pass def ir_right(self): """ Return true if the right IR sensor detects white. + rtype: boolean """ pass