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 1f8e5decc59402d6647ce8680d0b8e28d5f4ad04..11a0a732b85a42ec88fd2f8671956a1ac477975c 100644 (file)
--- 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):
     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)
 
         res = self.samdb.search(base=self.revision_object,
                                 attrs=["revision"], scope=ldb.SCOPE_BASE)