From: Garming Sam <garming@catalyst.net.nz>
Date: Wed, 13 Dec 2017 00:37:08 +0000 (+1300)
Subject: domain_update: Add a new docstring for the main entry point
X-Git-Tag: talloc-2.1.11~110
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=107fbaa8f1d95d6c7c0af2a3a9196fa950756c7e;p=thirdparty%2Fsamba.git

domain_update: Add a new docstring for the main entry point

Signed-off-by: Garming Sam <garming@catalyst.net.nz>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
---

diff --git a/python/samba/domain_update.py b/python/samba/domain_update.py
index 1f8e5decc59..11a0a732b85 100644
--- a/python/samba/domain_update.py
+++ b/python/samba/domain_update.py
@@ -123,6 +123,13 @@ class DomainUpdate(object):
     def check_updates_functional_level(self, functional_level,
                                        old_functional_level=None,
                                        update_revision=False):
+        """
+        Apply all updates for a given old and new functional level
+        :param functional_level: constant
+        :param old_functional_level: constant
+        :param update_revision: modify the stored version
+        :raise DomainUpdateException:
+        """
         res = self.samdb.search(base=self.revision_object,
                                 attrs=["revision"], scope=ldb.SCOPE_BASE)