Skip to content

Commit

Permalink
doc/builtins/Motor: return from run_until_stalled
Browse files Browse the repository at this point in the history
The return argument was not documented.
  • Loading branch information
laurensvalk committed Mar 25, 2020
1 parent ada5032 commit 43c006d
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion pybricks/builtins.py
Original file line number Diff line number Diff line change
Expand Up @@ -263,14 +263,17 @@ def run_target(self, speed, target_angle, then=Stop.HOLD, wait=True):

def run_until_stalled(self, speed, then=Stop.COAST, duty_limit=None):
"""Runs the motor at a constant speed until it
:ref:`stalls <stalled>`
:ref:`stalls <stalled>`.
Arguments:
speed (:ref:`speed`): Speed of the motor.
then (Stop): What to do after coming to a standstill.
duty_limit (:ref:`percentage`): Torque limit during this
command. This is useful to avoid applying the full motor
torque to a geared or lever mechanism.
Returns:
:ref:`angle`: Angle at which the motor becomes stalled.
"""
pass

Expand Down

0 comments on commit 43c006d

Please sign in to comment.