Added note about edge bfs behavior

spcl · Jun 20, 2024 · c5fa505 · c5fa505
1 parent c2d6676
commit c5fa505
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/dace/sdfg/graph.py b/dace/sdfg/graph.py
@@ -311,7 +311,10 @@ def __len__(self) -> int:
 
     def edge_bfs(self, node: Union[NodeT, Sequence[NodeT]], reverse: bool = False) -> Iterable[Edge[EdgeT]]:
         """Returns a generator over edges in the graph originating from the
-        passed node in BFS order"""
+        passed node in BFS order.
+
+        :note: All edges are yielded including back edges
+        """
         if isinstance(node, (tuple, list)):
             queue = deque(node)
         else: