Update docstrings in test.py #16

MissouriMRR · Feb 17, 2023 · 2632304 · 2632304
1 parent ba90ab4
commit 2632304
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/flight/avoidance/test.py b/flight/avoidance/test.py
@@ -88,6 +88,13 @@ async def avoiding_drone_test(
 ) -> None:
     """
     Runs test code for the drone trying to avoid the other drone
+
+    Parameters
+    ----------
+    drone : mavsdk.System
+        The drone this test will control
+    position_updates : AsyncIterator[list[InputPoint]]
+        Position updates for the drone this drone should avoid
     """
 
     asyncio.ensure_future(print_status_text(drone))
@@ -112,6 +119,11 @@ async def avoiding_drone_test(
 async def drone_to_avoid_test(drone: mavsdk.System) -> None:
     """
     Runs test code for the drone which the other drone should avoid
+
+    Parameters
+    ----------
+    drone : mavsdk.System
+        The drone this test will control
     """
 
     asyncio.ensure_future(print_status_text(drone))