KCC: Docstring for sort_replica_by_dsa_guid

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/source4/scripting/bin/samba_kcc b/source4/scripting/bin/samba_kcc
index 8213ce8802404f74aa2864b2e70a51a82b621d95..dbb6d62b9e81f1dfcef23dc6aa4c793ba7a62d11 100755 (executable)
--- a/source4/scripting/bin/samba_kcc
+++ b/source4/scripting/bin/samba_kcc
@@ -2747,6 +2747,14 @@ def get_spanning_tree_edges(graph, my_site, label=None):
 
 
 def sort_replica_by_dsa_guid(rep1, rep2):
+    """Helper to sort NCReplicas by their DSA guids
+
+    The guids need to be sorted in their NDR form.
+
+    :param rep1: An NC replica
+    :param rep2: Another replica
+    :return: -1, 0, or 1, indicating sort order.
+    """
     return cmp(ndr_pack(rep1.rep_dsa_guid), ndr_pack(rep2.rep_dsa_guid))