From 1e17b5ac66148387a18d078f4b21cc406beef4f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastien=20G=C3=A9rard?= Date: Sat, 5 Oct 2019 14:24:54 +0200 Subject: [PATCH] Fix docstring format to improve pycharm inspection --- mongoengine/base/document.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mongoengine/base/document.py b/mongoengine/base/document.py index a962a82b..2be8dd6f 100644 --- a/mongoengine/base/document.py +++ b/mongoengine/base/document.py @@ -62,13 +62,13 @@ class BaseDocument(object): """ Initialise a document or an embedded document. - :param dict values: A dictionary of keys and values for the document. + :param values: A dictionary of keys and values for the document. It may contain additional reserved keywords, e.g. "__auto_convert". - :param bool __auto_convert: If True, supplied values will be converted + :param __auto_convert: If True, supplied values will be converted to Python-type values via each field's `to_python` method. - :param set __only_fields: A set of fields that have been loaded for + :param __only_fields: A set of fields that have been loaded for this document. Empty if all fields have been loaded. - :param bool _created: Indicates whether this is a brand new document + :param _created: Indicates whether this is a brand new document or whether it's already been persisted before. Defaults to true. """ self._initialised = False