From c5fa505d99e7048bcdafea6fbffa213091fde940 Mon Sep 17 00:00:00 2001
From: Ben Weber <dev.ben.weber@gmail.com>
Date: Thu, 20 Jun 2024 13:53:10 +0200
Subject: [PATCH] Added note about edge bfs behavior

---
 dace/sdfg/graph.py | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/dace/sdfg/graph.py b/dace/sdfg/graph.py
index 34d88f826d..320e52d8e4 100644
--- 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: