Clarifying the docstring for the add_edge function (#2782)

Revised docstring for StateGraph's add_edge method to clarify recurring confusion #2775 #1462 --------- Co-authored-by: ashirgaokar <[email protected]> Co-authored-by: vbarda <[email protected]>
langchain-ai · Jan 7, 2025 · e00284b · e00284b
1 parent a36d2ac
commit e00284b
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/libs/langgraph/langgraph/graph/state.py b/libs/langgraph/langgraph/graph/state.py
@@ -398,9 +398,11 @@ def add_node(
         return self
 
     def add_edge(self, start_key: Union[str, list[str]], end_key: str) -> Self:
-        """Adds a directed edge from the start node to the end node.
+        """Adds a directed edge from the start node (or list of start nodes) to the end node.
 
-        If the graph transitions to the start_key node, it will always transition to the end_key node next.
+        When a single start node is provided, the graph will wait for that node to complete
+        before executing the end node. When multiple start nodes are provided,
+        the graph will wait for ALL of the start nodes to complete before executing the end node.
 
         Args:
             start_key (Union[str, list[str]]): The key(s) of the start node(s) of the edge.