Skip to content

Commit 09ab73d

Browse files
committed
Docstrings only
1 parent 1370047 commit 09ab73d

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

codeclash/games/abstract.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,10 @@ def determine_winner(self, agents: list[Player]) -> Any:
157157

158158
@abstractmethod
159159
def execute_round(self, agents: list[Player]):
160-
"""Subclasses implement their game-specific logic here, must write results to round_log_path"""
160+
"""Subclasses implement their game-specific logic here, must write results to round_log_path.
161+
This is the low level implementation, you probably want to use run_round instead, which
162+
includes the pre-round setup, post-round setup, and winner determination.
163+
"""
161164
pass
162165

163166
def _post_round_setup(self, agents: list[Player]):
@@ -196,7 +199,7 @@ def run_round(self, agents: list[Player]):
196199
"""
197200
Run a single round of the game with the given agents.
198201
199-
Returns a directory containing logs and results of the round(s).
202+
Writes to directory containing logs and results of the round(s).
200203
"""
201204
self._pre_round_setup(agents)
202205
self.execute_round(agents)

0 commit comments

Comments
 (0)