Merge pull request #58 from srajan-kiyotaka/sracho

change in docs.
srajan-kiyotaka · Jun 19, 2024 · 16c2445 · 16c2445
2 parents e08b204 + 3af52d6
commit 16c2445
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/graphWorld.md b/docs/graphWorld.md
@@ -9,8 +9,8 @@ Class representing a graph world.
   - '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): Radius of nodes in the visualization. Default is 20.
 - `fontSize` (int): Font size for node labels. Default is 12.
 - `fontBold` (bool): Whether node labels are bold. Default is True.

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.