KCC: improve docstring for KCC.is_bridgehead_failed()

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 58aff29b847d8dddc49e9a9b851000d8841320ad..6947f2db0af5b90b522c75337dff3eb2cc7b2e82 100755 (executable)
--- a/source4/scripting/bin/samba_kcc
+++ b/source4/scripting/bin/samba_kcc
@@ -1332,7 +1332,10 @@ class KCC(object):
 
     def is_bridgehead_failed(self, dsa, detect_failed):
         """Determine whether a given DC is known to be in a failed state
-        ::returns: True if and only if the DC should be considered failed
+
+        :param dsa: the bridgehead to test
+        :param detect_failed: True to really check, False to assume no failure
+        :return: True if and only if the DC should be considered failed
 
         Here we DEPART from the pseudo code spec which appears to be
         wrong. It says, in full: