Skip to content

Commit

Permalink
DOCS-2946: Remove non-blocking GoFor functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel authored Sep 19, 2024
1 parent abe0099 commit 8034fdd
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/viam/components/motor/motor.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ async def go_for(
Spin the motor the specified number of ``revolutions`` at specified ``rpm``.
When ``rpm`` or ``revolutions`` is a negative value, the rotation will be in the backward direction.
Note: if both ``rpm`` and ``revolutions`` are negative, the motor will spin in the forward direction.
If ``revolutions != 0``, this will block until the number of revolutions has been completed or another operation comes in.
``revolutions`` may not be 0.
::
Expand All @@ -83,7 +85,7 @@ async def go_for(
rpm (float): Speed at which the motor should move in rotations per minute
(negative implies backwards).
revolutions (float): Number of revolutions the motor should run for
(negative implies backwards).
(negative implies backwards). May not be 0.
For more information, see `Motor component <https://docs.viam.com/components/motor/>`_.
"""
Expand Down

0 comments on commit 8034fdd

Please sign in to comment.