KCC: docstring for kcc.graph.check_demote_vertex()

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 f3dc37348e4e4b87cc960ee4724cfa9181656e02..47850da7d281ced081b8d90652b7051c1cf74eb7 100644 (file)
--- a/python/samba/kcc/graph.py
+++ b/python/samba/kcc/graph.py
@@ -424,6 +424,14 @@ def try_new_path(graph, queue, vfrom, edge, vto):
 
 
 def check_demote_vertex(vertex, edge_type):
+    """Demote non-white vertices that accept only white edges
+
+    This makes them seem temporarily like white vertices.
+
+    :param vertex: a Vertex()
+    :param edge_type: a transport type GUID
+    :return: None
+    """
     if vertex.is_white():
         return