mirror of
https://github.com/pybricks/pybricks-api.git
synced 2026-09-15 02:54:52 +00:00
doc/parameters/Stop: move doc to rst
This commit is contained in:
@@ -1,8 +1,18 @@
|
||||
Stop
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: pybricks.parameters.Stop
|
||||
:no-members:
|
||||
.. class:: Stop
|
||||
|
||||
Action after the motor stops.
|
||||
|
||||
.. autoattribute:: pybricks.parameters.Stop.COAST
|
||||
:annotation:
|
||||
|
||||
.. autoattribute:: pybricks.parameters.Stop.BRAKE
|
||||
:annotation:
|
||||
|
||||
.. autoattribute:: pybricks.parameters.Stop.HOLD
|
||||
:annotation:
|
||||
|
||||
The following table shows how each stop type adds an extra level of
|
||||
resistance to motion. In these examples, ``m`` is a
|
||||
|
||||
+7
-15
@@ -89,25 +89,17 @@ class Port(_PybricksEnum):
|
||||
|
||||
|
||||
class Stop(_PybricksEnum):
|
||||
"""Action after the motor stops: coast, brake, or hold.
|
||||
|
||||
.. data:: COAST
|
||||
|
||||
Let the motor move freely.
|
||||
|
||||
.. data:: BRAKE
|
||||
|
||||
Passively resist small external forces.
|
||||
|
||||
.. data:: HOLD
|
||||
|
||||
Keep controlling the motor to hold it at the commanded angle. This is
|
||||
only available on motors with encoders.
|
||||
"""
|
||||
"""Action after the motor stops."""
|
||||
|
||||
COAST = 0
|
||||
"""Let the motor move freely."""
|
||||
|
||||
BRAKE = 1
|
||||
"""Passively resist small external forces."""
|
||||
|
||||
HOLD = 2
|
||||
"""Keep controlling the motor to hold it at the commanded angle. This is
|
||||
only available on motors with encoders."""
|
||||
|
||||
|
||||
class Direction(_PybricksEnum):
|
||||
|
||||
Reference in New Issue
Block a user