KCC: improve docstring for kcc.graph.get_spanning_tree_edges()

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 1944a494144b95dc02e78d105ae141af95956c0b..e586b6022cf0a9035bb5d6b810828aa005985fd5 100644 (file)
--- a/python/samba/kcc/graph.py
+++ b/python/samba/kcc/graph.py
@@ -109,6 +109,14 @@ def combine_repl_info(info_a, info_b, info_c):
 
 def get_spanning_tree_edges(graph, my_site, label=None, verify=False,
                             dot_file_dir=None):
+    """Find edges for the intersite graph
+
+    :param graph: a kcc.kcc_utils.Graph object
+    :param my_site: the topology generator's site
+    :param label: a label for use in dot files and verification
+    :param verify: if True, try to verify that graph properties are correct
+    :param dot_file_dir: if not None, write Graphviz dot files here
+    """
     # Phase 1: Run Dijkstra's to get a list of internal edges, which are
     # just the shortest-paths connecting colored vertices