Add extra context to the BaseDocument.validate docstring

This commit is contained in:
Stefan Wojcik 2019-06-12 11:37:08 +02:00
parent 4a8985278d
commit 15b6c1590f

View File

@ -348,6 +348,9 @@ class BaseDocument(object):
def validate(self, clean=True): def validate(self, clean=True):
"""Ensure that all fields' values are valid and that required fields """Ensure that all fields' values are valid and that required fields
are present. 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 # Ensure that each field is matched to a valid value
errors = {} errors = {}