From e7377dff3166bcccd63a5f6b1c175d8ffe90ac83 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Thu, 26 Oct 2023 14:31:16 +0200 Subject: [PATCH] pybricks.pupdevices.Motor: Clarify profile setting. --- src/pybricks/_common.py | 10 ++++++---- src/pybricks/pupdevices.py | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/src/pybricks/_common.py b/src/pybricks/_common.py index 13c28276..75d30d34 100644 --- a/src/pybricks/_common.py +++ b/src/pybricks/_common.py @@ -416,10 +416,12 @@ def __init__( Choose ``False`` to keep the current value, so your program knows where it left off last time. - profile (Number, deg): Precision profile. A lower value - means more precise movement; a larger value means - smoother movement. If no value is given, a suitable profile for - this motor type will be selected automatically. + profile (Number, deg): Precision profile. This is the approximate + position tolerance in degrees that is acceptable in your + application. A lower value gives more precise but more erratic + movement; a higher value gives less precise but smoother + movement. If no value is given, a suitable profile for this + motor type will be selected automatically (about 11 degrees). """ def angle(self) -> int: diff --git a/src/pybricks/pupdevices.py b/src/pybricks/pupdevices.py index ee4862f8..19a464db 100644 --- a/src/pybricks/pupdevices.py +++ b/src/pybricks/pupdevices.py @@ -70,10 +70,12 @@ def __init__( Choose ``False`` to keep the current value, so your program knows where it left off last time. - profile (Number, deg): Precision profile. A lower value - means more precise movement; a larger value means - smoother movement. If no value is given, a suitable profile for - this motor type will be selected automatically. + profile (Number, deg): Precision profile. This is the approximate + position tolerance in degrees that is acceptable in your + application. A lower value gives more precise but more erratic + movement; a higher value gives less precise but smoother + movement. If no value is given, a suitable profile for this + motor type will be selected automatically (about 11 degrees). """ def reset_angle(self, angle: Optional[Number] = None) -> None: