KCC: Slightly improve docstring for KCC.get_bridgehead()
authorDouglas Bagnall <douglas.bagnall@catalyst.net.nz>
Mon, 27 Apr 2015 23:29:47 +0000 (11:29 +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 d2c62c3c8e5b68ea8eadaf898111bd19736e1ba1..7234f911a5efff5e172b694cf0f31ef043145037 100755 (executable)
@@ -1190,7 +1190,9 @@ class KCC(object):
         return g
 
     def get_bridgehead(self, site, part, transport, partial_ok, detect_failed):
-        """Get a bridghead DC.
+        """Get a bridghead DC for a site.
+
+        Part of MS-ADTS 6.2.2.3.4.4
 
         :param site: site object representing for which a bridgehead
             DC is desired.
@@ -1203,7 +1205,7 @@ class KCC(object):
         :param detect_failed: True to detect failed DCs and route
             replication traffic around them, False to assume no DC
             has failed.
-        ::returns: dsa object for the bridgehead DC or None
+        :return: dsa object for the bridgehead DC or None
         """
 
         bhs = self.get_all_bridgeheads(site, part, transport,