Merge pull request #22713 from akhilnarang/fix-docstring

fix(model/document): add missing parameters to docstring and fix return type annotation
This commit is contained in:
Ankush Menat 2023-10-13 14:53:42 +05:30 committed by GitHub
commit 497807cbbc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -252,7 +252,13 @@ class Document(BaseDocument):
This will check for user permissions and execute `before_insert`,
`validate`, `on_update`, `after_insert` methods if they are written.
:param ignore_permissions: Do not check permissions if True."""
:param ignore_permissions: Do not check permissions if True.
:param ignore_links: Do not check validity of links if True.
:param ignore_if_duplicate: Do not raise error if a duplicate entry exists.
:param ignore_mandatory: Do not check missing mandatory fields if True.
:param set_name: Name to set for the document, if valid.
:param set_child_names: Whether to set names for the child documents.
"""
if self.flags.in_print:
return