description improved for cell.add

ardauzan · Dec 26, 2024 · 9ded20f · 9ded20f
1 parent 9d3f8d7
commit 9ded20f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/grid.gleam b/src/grid.gleam
@@ -41,6 +41,9 @@ pub fn is_empty(grid: Grid) -> Bool {
 }
 
 /// Add cell to grid.
+/// If the cell conflicts with another cell in the grid, the cell will not be added.
+/// If the cell is already in the grid, it will not be added.
+/// If the cell is dead, it will not be actually added.
 pub fn add(grid: Grid, cell: cel.Cell) -> Grid {
   case cel.is_alive(cell), cell_conflicts(grid, cel.toggle(cell)) {
     True, True -> grid