From 57fa27348c20bd8d9b3f565794ec0b56c544303b Mon Sep 17 00:00:00 2001
From: rasper <tomkerrdev@gmail.com>
Date: Sun, 2 Mar 2025 16:40:45 +0000
Subject: [PATCH] docs: improve/fix docstrings in behaviors

---
 src/ares/behaviors/combat/individual/__init__.py       |  6 ++++++
 src/ares/behaviors/combat/individual/drop_cargo.py     |  2 +-
 src/ares/behaviors/combat/individual/keep_unit_safe.py |  2 +-
 .../behaviors/combat/individual/path_unit_to_target.py |  5 +----
 src/ares/behaviors/combat/individual/pick_up_cargo.py  |  2 +-
 .../combat/individual/shoot_target_in_range.py         | 10 +++++-----
 .../behaviors/combat/individual/stutter_unit_back.py   |  2 +-
 .../combat/individual/stutter_unit_forward.py          |  2 +-
 src/ares/behaviors/combat/individual/use_ability.py    |  2 +-
 .../behaviors/combat/individual/worker_kite_back.py    |  2 +-
 10 files changed, 19 insertions(+), 16 deletions(-)

diff --git a/src/ares/behaviors/combat/individual/__init__.py b/src/ares/behaviors/combat/individual/__init__.py
index 4bb60ce..824bdf5 100644
--- a/src/ares/behaviors/combat/individual/__init__.py
+++ b/src/ares/behaviors/combat/individual/__init__.py
@@ -7,9 +7,15 @@
 from ares.behaviors.combat.individual.ghost_snipe import GhostSnipe
 from ares.behaviors.combat.individual.keep_unit_safe import KeepUnitSafe
 from ares.behaviors.combat.individual.medivac_heal import MedivacHeal
+from ares.behaviors.combat.individual.move_to_safe_target import MoveToSafeTarget
 from ares.behaviors.combat.individual.path_unit_to_target import PathUnitToTarget
+from ares.behaviors.combat.individual.pick_up_and_drop_cargo import PickUpAndDropCargo
 from ares.behaviors.combat.individual.pick_up_cargo import PickUpCargo
 from ares.behaviors.combat.individual.raven_auto_turret import RavenAutoTurret
+from ares.behaviors.combat.individual.reaper_grenade import ReaperGrenade
+from ares.behaviors.combat.individual.shoot_and_move_to_target import (
+    ShootAndMoveToTarget,
+)
 from ares.behaviors.combat.individual.shoot_target_in_range import ShootTargetInRange
 from ares.behaviors.combat.individual.siege_tank_decision import SiegeTankDecision
 from ares.behaviors.combat.individual.stutter_unit_back import StutterUnitBack
diff --git a/src/ares/behaviors/combat/individual/drop_cargo.py b/src/ares/behaviors/combat/individual/drop_cargo.py
index 3338c1c..48babf6 100644
--- a/src/ares/behaviors/combat/individual/drop_cargo.py
+++ b/src/ares/behaviors/combat/individual/drop_cargo.py
@@ -21,7 +21,7 @@ class DropCargo(CombatIndividualBehavior):
 
     Example:
     ```py
-    from ares.behaviors.combat import DropCargo
+    from ares.behaviors.combat.individual import DropCargo
 
     unit: Unit
     target: Unit
diff --git a/src/ares/behaviors/combat/individual/keep_unit_safe.py b/src/ares/behaviors/combat/individual/keep_unit_safe.py
index 018f8bb..2e50bcd 100644
--- a/src/ares/behaviors/combat/individual/keep_unit_safe.py
+++ b/src/ares/behaviors/combat/individual/keep_unit_safe.py
@@ -22,7 +22,7 @@ class KeepUnitSafe(CombatIndividualBehavior):
 
     Example:
     ```py
-    from ares.behaviors.combat import KeepUnitSafe
+    from ares.behaviors.combat.individual import KeepUnitSafe
 
     unit: Unit
     grid: np.ndarray = self.mediator.get_ground_grid
diff --git a/src/ares/behaviors/combat/individual/path_unit_to_target.py b/src/ares/behaviors/combat/individual/path_unit_to_target.py
index 00e08d2..fc1e21c 100644
--- a/src/ares/behaviors/combat/individual/path_unit_to_target.py
+++ b/src/ares/behaviors/combat/individual/path_unit_to_target.py
@@ -19,12 +19,9 @@
 class PathUnitToTarget(CombatIndividualBehavior):
     """Path a unit to its target destination.
 
-    TODO: Add attack enemy in range logic / parameter
-        Not added yet since that may be it's own Behavior
-
     Example:
     ```py
-    from ares.behaviors.combat import PathUnitToTarget
+    from ares.behaviors.combat.individual import PathUnitToTarget
 
     unit: Unit
     grid: np.ndarray = self.mediator.get_ground_grid
diff --git a/src/ares/behaviors/combat/individual/pick_up_cargo.py b/src/ares/behaviors/combat/individual/pick_up_cargo.py
index 535a486..714894b 100644
--- a/src/ares/behaviors/combat/individual/pick_up_cargo.py
+++ b/src/ares/behaviors/combat/individual/pick_up_cargo.py
@@ -27,7 +27,7 @@ class PickUpCargo(CombatIndividualBehavior):
 
     Example:
     ```py
-    from ares.behaviors.combat import PickUpCargo
+    from ares.behaviors.combat.individual import PickUpCargo
 
     unit: Unit # medivac for example
     grid: np.ndarray = self.mediator.get_ground_grid
diff --git a/src/ares/behaviors/combat/individual/shoot_target_in_range.py b/src/ares/behaviors/combat/individual/shoot_target_in_range.py
index 94d4f11..2e6b857 100644
--- a/src/ares/behaviors/combat/individual/shoot_target_in_range.py
+++ b/src/ares/behaviors/combat/individual/shoot_target_in_range.py
@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, Union
+from typing import TYPE_CHECKING
 
 from cython_extensions import cy_attack_ready, cy_in_attack_range, cy_pick_enemy_target
 from sc2.unit import Unit
@@ -23,11 +23,11 @@ class ShootTargetInRange(CombatIndividualBehavior):
 
     Example:
     ```py
-    from ares.behaviors.combat import ShootTargetInRange
+    from ares.behaviors.combat.individual import ShootTargetInRange
 
     unit: Unit
-    target: Unit
-    self.register_behavior(ShootTargetInRange(unit, target))
+    targets: Units | list[Unit]
+    self.register_behavior(ShootTargetInRange(unit, targets))
     ```
 
     Attributes:
@@ -39,7 +39,7 @@ class ShootTargetInRange(CombatIndividualBehavior):
     """
 
     unit: Unit
-    targets: Union[list[Unit], Units]
+    targets: list[Unit] | Units
     extra_range: float = 0.0
 
     def execute(
diff --git a/src/ares/behaviors/combat/individual/stutter_unit_back.py b/src/ares/behaviors/combat/individual/stutter_unit_back.py
index 056ce48..6fe9c5c 100644
--- a/src/ares/behaviors/combat/individual/stutter_unit_back.py
+++ b/src/ares/behaviors/combat/individual/stutter_unit_back.py
@@ -22,7 +22,7 @@ class StutterUnitBack(CombatIndividualBehavior):
 
     Example:
     ```py
-    from ares.behaviors.combat import StutterUnitBack
+    from ares.behaviors.combat.individual import StutterUnitBack
 
     unit: Unit
     target: Unit
diff --git a/src/ares/behaviors/combat/individual/stutter_unit_forward.py b/src/ares/behaviors/combat/individual/stutter_unit_forward.py
index 82f57fc..6814ca6 100644
--- a/src/ares/behaviors/combat/individual/stutter_unit_forward.py
+++ b/src/ares/behaviors/combat/individual/stutter_unit_forward.py
@@ -20,7 +20,7 @@ class StutterUnitForward(CombatIndividualBehavior):
 
     Example:
     ```py
-    from ares.behaviors.combat import StutterUnitForward
+    from ares.behaviors.combat.individual import StutterUnitForward
 
     unit: Unit
     target: Unit
diff --git a/src/ares/behaviors/combat/individual/use_ability.py b/src/ares/behaviors/combat/individual/use_ability.py
index d778fe4..dc69ee2 100644
--- a/src/ares/behaviors/combat/individual/use_ability.py
+++ b/src/ares/behaviors/combat/individual/use_ability.py
@@ -20,7 +20,7 @@ class UseAbility(CombatIndividualBehavior):
 
     Example:
     ```py
-    from ares.behaviors.combat import UseAbility
+    from ares.behaviors.combat.individual import UseAbility
     from sc2.ids.ability_id import AbilityId
 
     unit: Unit
diff --git a/src/ares/behaviors/combat/individual/worker_kite_back.py b/src/ares/behaviors/combat/individual/worker_kite_back.py
index a57361b..06814f2 100644
--- a/src/ares/behaviors/combat/individual/worker_kite_back.py
+++ b/src/ares/behaviors/combat/individual/worker_kite_back.py
@@ -23,7 +23,7 @@ class WorkerKiteBack(CombatIndividualBehavior):
 
     Example:
     ```py
-    from ares.behaviors.combat import WorkerKiteBack
+    from ares.behaviors.combat.individual import WorkerKiteBack
 
     unit: Unit
     target: Unit