KCC: docstring for kcc.graph.process_edge()

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 80d07d279afde9158797a8e08489eac612349d95..fe2185ad65c4880350cb2dd23d4169e8a9bfbd4a 100644 (file)
--- a/python/samba/kcc/graph.py
+++ b/python/samba/kcc/graph.py
@@ -480,7 +480,13 @@ def process_edge_set(graph, e_set, internal_edges):
 
 
 def process_edge(graph, examine, internal_edges):
-    # Find the set of all vertices touches the edge to examine
+    """Find the set of all vertices touching an edge to examine
+
+    :param graph: an IntersiteGraph object
+    :param examine: an edge
+    :param internal_edges: a set that internal edges get added to
+    :return: None
+    """
     vertices = []
     for v in examine.vertices:
         # Append a 4-tuple of color, repl cost, guid and vertex