KCC: docstring for kcc.graph.find_component()
authorDouglas Bagnall <douglas.bagnall@catalyst.net.nz>
Fri, 8 May 2015 02:52:13 +0000 (14:52 +1200)
committerAndrew Bartlett <abartlet@samba.org>
Fri, 12 Jun 2015 04:57:16 +0000 (06:57 +0200)
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>
python/samba/kcc/graph.py

index 1aa66c49feba6bc1632b906eaced62cfdd1ee45d..12956ae9e2e3253cf0dc4dd5069f11472489fd57 100644 (file)
@@ -602,6 +602,11 @@ def kruskal(graph, edges):
 
 
 def find_component(vertex):
+    """Kruskal helper to find the component a vertex belongs to.
+
+    :param vertex: a Vertex
+    :return: the Vertex object representing the component
+    """
     if vertex.component_id is vertex:
         return vertex