KCC: improve docstring for KCC.merge_failed_links()

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 ec089d62ed4f036afc0c15ca62d4f8f2a7475737..0100149c510f597e6ad2acd750747af75d18bf09 100755 (executable)
--- a/source4/scripting/bin/samba_kcc
+++ b/source4/scripting/bin/samba_kcc
@@ -1082,13 +1082,17 @@ class KCC(object):
 
     def merge_failed_links(self):
         """Merge of kCCFailedLinks and kCCFailedLinks from bridgeheads.
+
         The KCC on a writable DC attempts to merge the link and connection
         failure information from bridgehead DCs in its own site to help it
         identify failed bridgehead DCs.
-        """
-        # MS-TECH Ref 6.2.2.3.2 Merge of kCCFailedLinks and kCCFailedLinks
-        #     from Bridgeheads
 
+        Based on MS-ADTS 6.2.2.3.2 "Merge of kCCFailedLinks and kCCFailedLinks
+        from Bridgeheads"
+
+        :param ping: An oracle of current bridgehead availability
+        :return: None
+        """
         # 1. Queries every bridgehead server in your site (other than yourself)
         # 2. For every ntDSConnection that references a server in a different
         #    site merge all the failure info