Michel2/pybricks-api
1
0
Fork 0
mirror of https://github.com/pybricks/pybricks-api.git synced 2026-09-12 01:24:17 +00:00
Code Issues Releases Activity

doc/robotics: add note for when to change settings

Browse Source
This commit is contained in:
Laurens Valk
2020-03-17 15:47:54 +01:00
parent 9c8df9941f
commit aa343d017f
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/robotics.rst
+3
View File
@@ -49,6 +49,9 @@
the default speed and acceleration for straight maneuvers and turns.
Use the following attributes to adjust more advanced control setttings.
You can only change the settings while the robot is stopped. This is
either before you begin driving or after you call :meth:`.stop`.
.. autoattribute:: pybricks.robotics.DriveBase.distance_control
:annotation:
pybricks/robotics.py
+4 -1
View File
@@ -46,7 +46,7 @@ class DriveBase:
pass
def stop(self):
"""Stop the robot by coasting the motors."""
"""Stop the robot by letting the motors spin freely."""
pass
def distance(self):
@@ -87,6 +87,9 @@ class DriveBase:
If you give no arguments, this returns the current values as a tuple.
You can only change the settings while the robot is stopped. This is
either before you begin driving or after you call :meth:`.stop`.
Arguments:
straight_speed (:ref:`linspeed`): Speed of the robot during
:meth:`.straight`.