Skip to content

Commit 1aef35d

Browse files
committed
Update docs
1 parent b8fa5ca commit 1aef35d

File tree

11 files changed

+16
-16
lines changed

11 files changed

+16
-16
lines changed

docs/reference/arenas/battlecode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ BattleCode is a programming competition where players write Java code to control
1212

1313
## Implementation
1414

15-
::: codeclash.games.battlecode.battlecode.BattleCodeGame
15+
::: codeclash.arenas.battlecode.battlecode.BattleCodeArena
1616
options:
1717
show_root_heading: true
1818
heading_level: 2

docs/reference/arenas/battlesnake.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ players:
4545
4646
## Implementation
4747
48-
::: codeclash.games.battlesnake.battlesnake.BattleSnakeGame
48+
::: codeclash.arenas.battlesnake.battlesnake.BattleSnakeArena
4949
options:
5050
show_root_heading: true
5151
heading_level: 2

docs/reference/arenas/corewar.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ players:
3535
3636
## Implementation
3737
38-
::: codeclash.games.corewar.corewar.CoreWarGame
38+
::: codeclash.arenas.corewar.corewar.CoreWarArena
3939
options:
4040
show_root_heading: true
4141
heading_level: 2

docs/reference/arenas/dummy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ DummyGame is a minimal game implementation used for testing the CodeClash framew
88

99
## Implementation
1010

11-
::: codeclash.games.dummy.dummy_game.DummyGame
11+
::: codeclash.arenas.dummy.dummy.DummyArena
1212
options:
1313
show_root_heading: true
1414
heading_level: 2

docs/reference/arenas/game.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# CodeGame (Abstract Base)
1+
# CodeArena (Abstract Base)
22

3-
The `CodeGame` class is the abstract base class for all game arenas in CodeClash.
3+
The `CodeArena` class is the abstract base class for all game arenas in CodeClash.
44

55
## Overview
66

7-
Every game in CodeClash extends `CodeGame` and implements three key methods:
7+
Every game in CodeClash extends `CodeArena` and implements three key methods:
88

99
1. `validate_code()`: Verify that player submissions are valid
1010
2. `execute_round()`: Run the actual game
@@ -33,7 +33,7 @@ Each game runs in its own Docker container with:
3333

3434
## Class Reference
3535

36-
::: codeclash.games.game.CodeGame
36+
::: codeclash.arenas.arena.CodeArena
3737
options:
3838
show_root_heading: true
3939
heading_level: 2
@@ -42,14 +42,14 @@ Each game runs in its own Docker container with:
4242

4343
### PlayerStats
4444

45-
::: codeclash.games.game.PlayerStats
45+
::: codeclash.arenas.arena.PlayerStats
4646
options:
4747
show_root_heading: true
4848
heading_level: 3
4949

5050
### RoundStats
5151

52-
::: codeclash.games.game.RoundStats
52+
::: codeclash.arenas.arena.RoundStats
5353
options:
5454
show_root_heading: true
5555
heading_level: 3

docs/reference/arenas/halite.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ players:
3636
3737
## Implementation
3838
39-
::: codeclash.games.halite.halite.HaliteGame
39+
::: codeclash.arenas.halite.halite.HaliteArena
4040
options:
4141
show_root_heading: true
4242
heading_level: 2

docs/reference/arenas/halite2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Halite II introduces planetary docking, combat, and more complex strategies.
1212

1313
## Implementation
1414

15-
::: codeclash.games.halite2.halite2.Halite2Game
15+
::: codeclash.arenas.halite2.halite2.Halite2Arena
1616
options:
1717
show_root_heading: true
1818
heading_level: 2

docs/reference/arenas/halite3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Halite III returns to the resource collection mechanics with new twists.
1212

1313
## Implementation
1414

15-
::: codeclash.games.halite3.halite3.Halite3Game
15+
::: codeclash.arenas.halite3.halite3.Halite3Arena
1616
options:
1717
show_root_heading: true
1818
heading_level: 2

docs/reference/arenas/huskybench.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Huskybench is an implementation of Husky Hold'em
1212

1313
## Implementation
1414

15-
::: codeclash.games.huskybench.huskybench.HuskyBenchGame
15+
::: codeclash.arenas.huskybench.huskybench.HuskyBenchArena
1616
options:
1717
show_root_heading: true
1818
heading_level: 2

docs/reference/arenas/robocode.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ players:
3636
3737
## Implementation
3838
39-
::: codeclash.games.robocode.robocode.RoboCodeGame
39+
::: codeclash.arenas.robocode.robocode.RoboCodeArena
4040
options:
4141
show_root_heading: true
4242
heading_level: 2

0 commit comments

Comments
 (0)