updated feedback folding docstring

byuccl · Nov 7, 2023 · 072b7b6 · 072b7b6
1 parent b706003
commit 072b7b6
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/spydrnet_tmr/analysis/feedback_folding.py b/spydrnet_tmr/analysis/feedback_folding.py
@@ -5,9 +5,13 @@
 
 def fold_feedback(connectivity_graph, verbose=True):
     '''
-    Analyzes tight feedback in a design.
+    Analyzes feedback in a design. Takes a networkx digraph and returns the following:
+    
+    feedback_hierarchy - frozensets inside frozensets inside frozensets. Feedback hierarchy from large loops down to small loops
+    distances - a dictionary. Keys are frozensets of hinstances in the feedback loop. Item is the distance.
+    working_graph - networkx digraph. The resulting graph after all feedback has been folded down
 
-    :param connectivity_graph:
+    :param connectivity_graph: A networkx digraph created
     '''
     sccs = list(sorted(nx.strongly_connected_components(connectivity_graph), key=len))
     scc_count = len(sccs)