KCC: Add graph.InternalEdge.__lt__ 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 e40844eb474f6e00aa8c72ae9c314d48cea97d9d..12e53f598b348175c3510076a87b883a201f9023 100644 (file)
--- a/python/samba/kcc/graph.py
+++ b/python/samba/kcc/graph.py
@@ -751,6 +751,18 @@ class InternalEdge(object):
 
     # TODO compare options and interval
     def __lt__(self, other):
+        """Here "less than" means "better".
+
+        From within MS-ADTS 6.2.2.3.4.4:
+
+        SORT internalEdges by (descending RedRed,
+                               ascending ReplInfo.Cost,
+                               descending available time in ReplInfo.Schedule,
+                               ascending V1ID,
+                               ascending V2ID,
+                               ascending Type)
+
+        """
         if self.red_red != other.red_red:
             return self.red_red