Skip to content

Commit 2c2179d

Browse files
committed
Fix docstring for compute_module_merge
Was missing all information about return values.
1 parent a020c2d commit 2c2179d

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

brainx/modularity.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,16 @@ def compute_module_merge(self, m1, m2):
192192
193193
Returns
194194
-------
195-
195+
merged_module : set of merged nodes
196+
e1[0] : element of e vector for merged module
197+
a1[0] : element of a vector for merged module
198+
-delta_q : change in modularity induced by this change
199+
'merge' : string indicating the type of change that was applied
200+
m1 : index of the first merged module
201+
m2 : index of the second merged module
202+
m2 : index of the second merged module
196203
"""
204+
197205
# Below, we want to know that m1<m2, so we enforce that:
198206
if m1>m2:
199207
m1, m2 = m2, m1

0 commit comments

Comments
 (0)