KCC: improve docstring for KCC.load_all_sitelinks()
authorDouglas Bagnall <douglas.bagnall@catalyst.net.nz>
Fri, 24 Apr 2015 04:52:59 +0000 (16:52 +1200)
committerAndrew Bartlett <abartlet@samba.org>
Sat, 30 May 2015 19:05:24 +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 e76e56a8d1f4b74596321cb036c928579a5d8cd1..753d502226e79b9f956b8db341e781bbab6f0ac8 100755 (executable)
@@ -140,7 +140,8 @@ class KCC(object):
     def load_all_sitelinks(self):
         """Loads the inter-site siteLink objects
 
-        ::returns: Raises KCCError on error
+        :return: None
+        :raise KCCError: if site-links aren't found
         """
         try:
             res = self.samdb.search("CN=Inter-Site Transports,CN=Sites,%s" %