doc: group motor methods by rubric

This commit is contained in:
Laurens Valk
2019-01-11 09:03:18 +01:00
parent 1cb21098a5
commit 34bc88dae3
+3 -1
View File
@@ -19,7 +19,7 @@ class Motor():
Arguments:
port (Port): Port to which the motor is connected
direction (Direction): Positive speed direction. (*Default*: Direction.clockwise)
gears (list): List of gears linked to the motor. (*Default*: ``None``)
gears (list): List of gears linked to the motor. (*Default*: ``None``).
For example: ``[12, 36]`` represents a gear train with a 12-tooth and a 36-tooth gear. See :ref:`ratio` for illustrated examples.
@@ -31,6 +31,8 @@ class Motor():
The same holds for the documentation below: When it says "motor angle" or "motor speed", you can read it as "mechanism output angle" and "mechanism output speed", and so on, because the gear ratio is automatically accounted for.
The ``gears`` setting is only available for motors with rotation sensors.
::
# Initialize a motor (by default this means clockwise, without any gears).