KCC: docstring for kcc.graph.process_edge_set()

Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Garming Sam <garming@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>

diff --git a/python/samba/kcc/graph.py b/python/samba/kcc/graph.py
index db8864f5c15d737617306484f29f28576e549a05..80d07d279afde9158797a8e08489eac612349d95 100644 (file)
--- a/python/samba/kcc/graph.py
+++ b/python/samba/kcc/graph.py
@@ -460,6 +460,13 @@ def undemote_vertex(vertex):
 
 
 def process_edge_set(graph, e_set, internal_edges):
+    """Find internal edges to pass to Kruskal's algorithm
+
+    :param graph: an IntersiteGraph object
+    :param e_set: an edge set
+    :param internal_edges: a set that internal edges get added to
+    :return: None
+    """
     if e_set is None:
         for edge in graph.edges:
             for vertex in edge.vertices: