KCC: improve docstring for KCC.load_all_partitions()
authorDouglas Bagnall <douglas.bagnall@catalyst.net.nz>
Mon, 27 Apr 2015 23:22:40 +0000 (11:22 +1200)
committerAndrew Bartlett <abartlet@samba.org>
Sat, 30 May 2015 19:05:25 +0000 (21:05 +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>
source4/scripting/bin/samba_kcc

index d483d01c163f1e592be18bc72d27da1bcead122d..d2c62c3c8e5b68ea8eadaf898111bd19736e1ba1 100755 (executable)
@@ -274,13 +274,13 @@ class KCC(object):
             self.dsa_by_guid[str(self.my_dsa.dsa_guid)] = self.my_dsa
 
     def load_all_partitions(self):
-        """Discover all NCs thru the Partitions dn and
-        instantiate and load the NCs.
+        """Discover and load all partitions.
 
         Each NC is inserted into the part_table by partition
         dn string (not the nCName dn string)
 
-        ::returns: Raises KCCError on error
+        :return: None
+        :raise: KCCError if partitions can't be found
         """
         try:
             res = self.samdb.search("CN=Partitions,%s" %