pybricks.pupdevices.Motor: Document close.

pybricks · Nov 20, 2023 · f509178 · f509178
1 parent fd61866
commit f509178
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,7 @@
 
 ## Added
 - Enabled tilt and orientation config for `MoveHub()`.
+- Documented `Motor.close()`
 
 ## Fixed
 - Fixed missing awaitable for `Remote.light` and LWP3 writes.

diff --git a/doc/main/pupdevices/motor.rst b/doc/main/pupdevices/motor.rst
@@ -62,6 +62,8 @@ Motors with rotation sensors
 
     .. automethod:: pybricks.pupdevices.Motor.settings
 
+    .. automethod:: pybricks.pupdevices.Motor.close
+
     .. rubric:: Control settings
 
     .. pybricks-requirements:: pybricks-common-control

diff --git a/src/pybricks/_common.py b/src/pybricks/_common.py
@@ -605,6 +605,16 @@ def track_target(self, target_angle: Number) -> None:
                 rotate to.
         """
 
+    def close(self) -> None:
+        """close()
+
+        Closes the motor object so you can call ``Motor`` again to initialize
+        a new object.
+
+        This allows advanced users to change properties such as gearing in the
+        middle of the program, which can be useful for removeable attachments.
+        """
+
 
 class Speaker:
     """Plays beeps and sounds using a speaker."""