clarified and fixed typo in GraphInstance docstring (#3100)

openai · Oct 4, 2022 · 2ac7b1c · 2ac7b1c
1 parent 4544bb9
commit 2ac7b1c
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/gym/spaces/graph.py b/gym/spaces/graph.py
@@ -14,8 +14,8 @@ class GraphInstance(NamedTuple):
     """A Graph space instance.
 
     * nodes (np.ndarray): an (n x ...) sized array representing the features for n nodes, (...) must adhere to the shape of the node space.
-    * edges (Optional[np.ndarray]): an (m x ...) sized array representing the features for m nodes, (...) must adhere to the shape of the edge space.
-    * edge_links (Optional[np.ndarray]): an (m x 2) sized array of ints representing the two nodes that each edge connects.
+    * edges (Optional[np.ndarray]): an (m x ...) sized array representing the features for m edges, (...) must adhere to the shape of the edge space.
+    * edge_links (Optional[np.ndarray]): an (m x 2) sized array of ints representing the indices of the two nodes that each edge connects.
     """
 
     nodes: np.ndarray