KCC: improve docstring for KCC.list_dsas()

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 032c3a09732d16f1be6f1a6a524ebedf13008609..2a390046cfb625d78937017d132eb28a60835419 100755 (executable)
--- a/source4/scripting/bin/samba_kcc
+++ b/source4/scripting/bin/samba_kcc
@@ -2426,6 +2426,16 @@ class KCC(object):
             mydsa.commit_connections(self.samdb)
 
     def list_dsas(self):
+        """Compile a comprehensive list of DSA DNs
+
+        These are all the DSAs on all the sites that KCC would be
+        dealing with.
+
+        This method is not idempotent and may not work correctly in
+        sequence with KCC.run().
+
+        :return: a list of DSA DN strings.
+        """
         self.load_my_site()
         self.load_my_dsa()