KCC: improve docstring for is_smtp_replication_available()

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 bb04b9328cb48d7a49cdbc86e3367df424127b43..968957fca0d24ee7cc9203a5e42bd05c8e13e740 100755 (executable)
--- a/source4/scripting/bin/samba_kcc
+++ b/source4/scripting/bin/samba_kcc
@@ -2776,9 +2776,12 @@ def sort_dsa_by_gc_and_guid(dsa1, dsa2):
 
 
 def is_smtp_replication_available():
-    """Currently always returns false because Samba
-    doesn't implement SMTP transfer for NC changes
-    between DCs
+    """Can the KCC use SMTP replication?
+
+    Currently always returns false because Samba doesn't implement
+    SMTP transfer for NC changes between DCs.
+
+    :return: Boolean (always False)
     """
     return False