KCC: improve docstring for KCC.plot_all_connections()
authorDouglas Bagnall <douglas.bagnall@catalyst.net.nz>
Wed, 29 Apr 2015 23:33:23 +0000 (11:33 +1200)
committerAndrew Bartlett <abartlet@samba.org>
Fri, 12 Jun 2015 04:57:14 +0000 (06:57 +0200)
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>
python/samba/kcc/__init__.py

index 3d0b1846bf256d5298e8e5eb7ed0092bb681537f..7d0c5e07f9d4d68a0318b95d4130c04f5dfe66d5 100644 (file)
@@ -2458,6 +2458,11 @@ class KCC(object):
                            credentials=creds, lp=lp)
 
     def plot_all_connections(self, basename, verify_properties=()):
+        """Helper function to plot and verify NTDSConnections
+
+        :param basename: an identifying string to use in filenames and logs.
+        :param verify_properties: properties to verify (default empty)
+        """
         verify = verify_properties and self.verify
         if not verify and self.dot_file_dir is None:
             return