KCC: Add samba.kcc.graph.create_edge() 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 1155be3ea0ba5939ce436526a9e0def5b8ba4c7b..40852f7bebc72cc6fed80678c284ad1941efae38 100644 (file)
--- a/python/samba/kcc/graph.py
+++ b/python/samba/kcc/graph.py
@@ -273,6 +273,17 @@ def get_spanning_tree_edges(graph, my_site, label=None, verify=False,
 
 
 def create_edge(con_type, site_link, guid_to_vertex):
+    """Set up a MultiEdge for the intersite graph
+
+    A MultiEdge can have multiple vertices.
+
+    From MS-ADTS 6.2.2.3.4.4
+
+    :param con_type: a transport type GUID
+    :param  site_link: a kcc.kcc_utils.SiteLink object
+    :param guid_to_vertex: a mapping between GUIDs and vertices
+    :return: a MultiEdge
+    """
     e = MultiEdge()
     e.site_link = site_link
     e.vertices = []