From: Douglas Bagnall Date: Mon, 27 Apr 2015 23:31:51 +0000 (+1200) Subject: KCC: improve docstring for KCC.is_bridgehead_failed() X-Git-Tag: tevent-0.9.25~216 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=3bc288019bec26bd9b7077a54416a8ec920d6b31;p=thirdparty%2Fsamba.git KCC: improve docstring for KCC.is_bridgehead_failed() Signed-off-by: Douglas Bagnall Reviewed-by: Garming Sam Reviewed-by: Andrew Bartlett --- diff --git a/source4/scripting/bin/samba_kcc b/source4/scripting/bin/samba_kcc index 58aff29b847..6947f2db0af 100755 --- 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: