Skip to content

Commit

Permalink
docs: improve/fix docstrings in behaviors
Browse files Browse the repository at this point in the history
  • Loading branch information
raspersc2 committed Mar 2, 2025
1 parent 6386c75 commit 57fa273
Show file tree
Hide file tree
Showing 10 changed files with 19 additions and 16 deletions.
6 changes: 6 additions & 0 deletions src/ares/behaviors/combat/individual/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ares/behaviors/combat/individual/drop_cargo.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ares/behaviors/combat/individual/keep_unit_safe.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 1 addition & 4 deletions src/ares/behaviors/combat/individual/path_unit_to_target.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ares/behaviors/combat/individual/pick_up_cargo.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions src/ares/behaviors/combat/individual/shoot_target_in_range.py
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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:
Expand All @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion src/ares/behaviors/combat/individual/stutter_unit_back.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ares/behaviors/combat/individual/use_ability.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ares/behaviors/combat/individual/worker_kite_back.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 57fa273

Please sign in to comment.