Skip to content

Commit 37c0a95

Browse files
mst-abletonzeroshade
authored andcommitted
Update documentation (#24)
* Update docs to use new class name * Make types nonrecursive * Display inherited members from BaseRest This is done explicitly to not also include members from Quart.
1 parent d63cd80 commit 37c0a95

2 files changed

Lines changed: 20 additions & 5 deletions

File tree

docs/pint.rst

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,32 @@
33
.. currentmodule:: quart_openapi
44

55
Pint Class
6-
=============
6+
==========
77

88
.. autoclass:: Pint
9-
:members:
9+
:members: handle_json_validation_exc, resources, base_model, get_validator, param,
10+
response, route, create_ref_validator, create_validator, doc, expect,
11+
default_id
12+
:show-inheritance:
13+
14+
.. automethod:: __init__
15+
16+
17+
PintBlueprint Class
18+
===================
19+
20+
.. autoclass:: PintBlueprint
21+
:members: handle_json_validation_exc, resources, base_model, get_validator, param,
22+
response, route, create_ref_validator, create_validator, doc, expect,
23+
default_id, register
1024
:show-inheritance:
1125

1226
.. automethod:: __init__
1327

14-
SwaggerView helper
28+
OpenApiView helper
1529
------------------
1630

17-
.. autoclass:: SwaggerView
31+
.. autoclass:: OpenApiView
1832
:members:
1933
:inherited-members:
2034
:show-inheritance:

quart_openapi/typing.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
from jsonschema import Draft4Validator
33

44
PyTypes = Union[Type[int], Type[float], Type[str], Type[bool]]
5-
ValidatorTypes = Union[PyTypes, str, Draft4Validator, Iterable['ValidatorTypes']]
5+
ValidatorType = Union[PyTypes, str, Draft4Validator]
6+
ValidatorTypes = Union[ValidatorType, Iterable['ValidatorType']]
67
ExpectedDescList = Union[ValidatorTypes, Tuple[ValidatorTypes], Tuple[ValidatorTypes, str],
78
Tuple[ValidatorTypes, str, Dict[str, Any]]]
89
HeaderType = Union[PyTypes, str, Iterable[PyTypes], Draft4Validator, Dict[str, Any]]

0 commit comments

Comments
 (0)