summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorDouglas Bagnall <douglas.bagnall@catalyst.net.nz>2015-05-08 11:03:37 +1200
committerAndrew Bartlett <abartlet@samba.org>2015-06-12 06:57:16 +0200
commit61c1d8ad390c70507618bde1a6c659e92a62e286 (patch)
tree5a8f6b0b3686b247605bbd740dde3dcad64bd1a7 /python
parenta75b87490232a599c1aa3d0ccef660334eea9cc7 (diff)
downloadsamba-61c1d8ad390c70507618bde1a6c659e92a62e286.tar.gz
KCC: docstring for kcc.graph.process_edge()
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>
Diffstat (limited to 'python')
-rw-r--r--python/samba/kcc/graph.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/python/samba/kcc/graph.py b/python/samba/kcc/graph.py
index 80d07d279af..fe2185ad65c 100644
--- a/python/samba/kcc/graph.py
+++ b/python/samba/kcc/graph.py
@@ -480,7 +480,13 @@ def process_edge_set(graph, e_set, internal_edges):
def process_edge(graph, examine, internal_edges):
- # Find the set of all vertices touches the edge to examine
+ """Find the set of all vertices touching an edge to examine
+
+ :param graph: an IntersiteGraph object
+ :param examine: an edge
+ :param internal_edges: a set that internal edges get added to
+ :return: None
+ """
vertices = []
for v in examine.vertices:
# Append a 4-tuple of color, repl cost, guid and vertex