pybricks.pupdevices.Motor: Clarify profile setting.

pybricks · Oct 26, 2023 · e7377df · e7377df
1 parent d935841
commit e7377df
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git 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
@@ -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: