Skip to content

Commit e7377df

Browse files
committed
pybricks.pupdevices.Motor: Clarify profile setting.
1 parent d935841 commit e7377df

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

src/pybricks/_common.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -416,10 +416,12 @@ def __init__(
416416
Choose ``False`` to keep the
417417
current value, so your program knows where it left off last
418418
time.
419-
profile (Number, deg): Precision profile. A lower value
420-
means more precise movement; a larger value means
421-
smoother movement. If no value is given, a suitable profile for
422-
this motor type will be selected automatically.
419+
profile (Number, deg): Precision profile. This is the approximate
420+
position tolerance in degrees that is acceptable in your
421+
application. A lower value gives more precise but more erratic
422+
movement; a higher value gives less precise but smoother
423+
movement. If no value is given, a suitable profile for this
424+
motor type will be selected automatically (about 11 degrees).
423425
"""
424426

425427
def angle(self) -> int:

src/pybricks/pupdevices.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,10 +70,12 @@ def __init__(
7070
Choose ``False`` to keep the
7171
current value, so your program knows where it left off last
7272
time.
73-
profile (Number, deg): Precision profile. A lower value
74-
means more precise movement; a larger value means
75-
smoother movement. If no value is given, a suitable profile for
76-
this motor type will be selected automatically.
73+
profile (Number, deg): Precision profile. This is the approximate
74+
position tolerance in degrees that is acceptable in your
75+
application. A lower value gives more precise but more erratic
76+
movement; a higher value gives less precise but smoother
77+
movement. If no value is given, a suitable profile for this
78+
motor type will be selected automatically (about 11 degrees).
7779
"""
7880

7981
def reset_angle(self, angle: Optional[Number] = None) -> None:

0 commit comments

Comments
 (0)