Add extra context to the BaseDocument.validate docstring

2019-06-12 11:37:08 +02:00 · 2019-06-12 11:37:08 +02:00 · 15b6c1590f
commit 15b6c1590f
parent 4a8985278d
1 changed files with 3 additions and 0 deletions
--- a/mongoengine/base/document.py
+++ b/mongoengine/base/document.py
@ -348,6 +348,9 @@ class BaseDocument(object):
    def validate(self, clean=True):
        """Ensure that all fields' values are valid and that required fields
        are present.
+
+        Raises :class:`ValidationError` if any of the fields' values are found
+        to be invalid.
        """
        # Ensure that each field is matched to a valid value
        errors = {}