change in doc string of world module.

srajan-kiyotaka · Jun 19, 2024 · 3af52d6 · 3af52d6
1 parent 0702d46
commit 3af52d6
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/src/traverseCraft/world.py b/src/traverseCraft/world.py
@@ -418,8 +418,8 @@ class CreateTreeWorld:
                 - 'goals' (list): List of goal node IDs.
                 - 'adj' (dict): Adjacency list representing tree connections.
                 - 'position' (dict): Dictionary of node positions with node IDs as keys.
-                - 'edges' (dict, optional): Dictionary of edge information. Default is None.
-                - 'vals' (dict, optional): Dictionary of node values. Default is None.
+                - 'edges' (dict, optional): Dictionary of edge value. Default each edge is assigned a value of 1.
+                - 'vals' (dict, optional): Dictionary of node values. Default each node is assigned the value same as its ID.
             - radius (int): The radius of the nodes in the world visualization. Default is 20.
             - fontSize (int): The font size of the node labels. Default is 12.
             - fontBold (bool): Whether to use bold font for the node labels. Default is True.
@@ -914,8 +914,8 @@ class CreateGraphWorld:
                 - 'goals' (list): List of goal node IDs.
                 - 'adj' (dict): Adjacency list representing graph connections.
                 - 'position' (dict): Dictionary of node positions with node IDs as keys.
-                - 'edges' (dict, optional): Dictionary of edge information. Default is None.
-                - 'vals' (dict, optional): Dictionary of node values. Default is None.
+                - 'edges' (dict, optional): Dictionary of edge value. Default each edge is assigned a value of 1.
+                - 'vals' (dict, optional): Dictionary of node values. Default each node is assigned the value same as its ID.
             - radius (int): The radius of the nodes in the world visualization. Default is 20.
             - fontSize (int): The font size of the node labels. Default is 12.
             - fontBold (bool): Whether to use bold font for the node labels. Default is True.