pybricks.robotics.DriveBase: Add brake.

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

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/doc/main/robotics.rst b/doc/main/robotics.rst
@@ -39,6 +39,8 @@
 
     .. automethod:: pybricks.robotics.DriveBase.stop
 
+    .. automethod:: pybricks.robotics.DriveBase.brake
+
     .. rubric:: Measuring
 
     .. automethod:: pybricks.robotics.DriveBase.distance

diff --git a/jedi/tests/test_get_signature.py b/jedi/tests/test_get_signature.py
@@ -985,6 +985,7 @@ def _get_method_signature(module: str, type: str, method: str) -> SignatureHelp:
         [(["speed: Number", "turn_rate: Number"], "None")],
     ),
     pytest.param("pybricks.robotics", "DriveBase", "stop", [([], "None")]),
+    pytest.param("pybricks.robotics", "DriveBase", "brake", [([], "None")]),
     pytest.param("pybricks.robotics", "DriveBase", "distance", [([], "int")]),
     pytest.param("pybricks.robotics", "DriveBase", "angle", [([], "int")]),
     pytest.param(

diff --git a/src/pybricks/robotics.py b/src/pybricks/robotics.py
@@ -86,6 +86,12 @@ def stop(self) -> None:
 
         Stops the robot by letting the motors spin freely."""
 
+    def brake(self) -> None:
+        """brake()
+
+        Stops the robot by passively braking the motors.
+        """
+
     def distance(self) -> int:
         """distance() -> int: mm