Update NetworkGrid.__init__ docstring

Specify that NetworkGrid requires a Networkx graph instance.
jeanremacle · Nov 7, 2022 · a783971 · a783971
1 parent 45171f3
commit a783971
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/mesa/space.py b/mesa/space.py
@@ -974,6 +974,11 @@ class NetworkGrid:
     """Network Grid where each node contains zero or more agents."""
 
     def __init__(self, G: Any) -> None:
+        """Create a new network.
+
+        Args:
+            G: a NetworkX graph instance.
+        """
         self.G = G
         for node_id in self.G.nodes:
             G.nodes[node_id]["agent"] = self.default_val()