KCC: docstring for kcc.graph.InternalEdge

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 d47d2f80c6ff522106f99c14bffee1a06ca3fe68..daea4915278f99cb9011e1fcc57fc73b92ce679a 100644 (file)
--- a/python/samba/kcc/graph.py
+++ b/python/samba/kcc/graph.py
@@ -803,6 +803,12 @@ class MultiEdge(object):
 
 
 class InternalEdge(object):
+    """An edge that forms part of the minimal spanning tree
+
+    These are used in the Kruskal's algorithm. Their interesting
+    feature isa that they are sortable, with the good edges sorting
+    before the bad ones -- lower is better.
+    """
     def __init__(self, v1, v2, redred, repl, eType, site_link):
         self.v1 = v1
         self.v2 = v2