KCC: Add graph.setup_vertices() docstring

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 6eb443452b2a35498abcbe05f5bf937090787040..a005c59c7f39b592f91a0689973c7e58582dae8c 100644 (file)
--- a/python/samba/kcc/graph.py
+++ b/python/samba/kcc/graph.py
@@ -324,6 +324,11 @@ def create_edge_set(graph, transport, site_link_bridge):
 
 
 def setup_vertices(graph):
+    """Initialise vertices in the graph for the Dijkstra's run.
+
+    :param graph: an IntersiteGraph object
+    :return: None
+    """
     for v in graph.vertices:
         if v.is_white():
             v.repl_info.cost = MAX_DWORD