next part of the docs and api documentation in beta ver

This commit is contained in:
collerek
2021-01-04 19:38:21 +01:00
parent eec17e2f78
commit 9f8e8e87e8
64 changed files with 7414 additions and 37 deletions

View File

@ -2,6 +2,7 @@
Module with all decorators that are exposed for users.
Currently only:
* property_field - exposing @property like function as field in Model.dict()
* predefined signals decorators (pre/post + save/update/delete)

View File

@ -13,7 +13,7 @@ def property_field(func: Callable) -> Union[property, Callable]:
mypy validation will complain about this.
Note that "fields" exposed like this do not go through validation.
:raises: ModelDefinitionError if method has any other argument than self.
:raises ModelDefinitionError: if method has any other argument than self.
:param func: decorated function to be exposed
:type func: Callable
:return: decorated function passed in func param, with set __property_field__ = True