Add docstring to bfs_walk

bcollazo · Jul 6, 2021 · 59062b3 · 59062b3
1 parent 4f43341
commit 59062b3
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/catanatron/models/board.py b/catanatron/models/board.py
@@ -147,6 +147,16 @@ def build_settlement(self, color, node_id, initial_build_phase=False):
         return previous_road_color, self.road_color, self.road_lengths
 
     def bfs_walk(self, node_id, color):
+        """Generates set of nodes that are "connected" to given node.
+
+        Args:
+            node_id (int): Where to start search/walk.
+            color (Color): Player color asking
+
+        Returns:
+            Set[int]: Nodes that are "connected" to this one
+                by roads of the color player.
+        """
         agenda = [node_id]  # assuming node_id is owned.
         visited = set()