Fix tuple types in sphinx docstrings
This commit is contained in:
@@ -203,7 +203,7 @@ class FieldInspector(BaseInspector):
|
||||
- :class:`.Schema` if `swagger_object_type` is :class:`.Schema`
|
||||
- :class:`.Items` if `swagger_object_type` is :class:`.Parameter` or :class:`.Items`
|
||||
|
||||
:rtype: tuple[callable,(type[openapi.Schema] or type[openapi.Items])]
|
||||
:rtype: (function,type[openapi.Schema] or type[openapi.Items])
|
||||
"""
|
||||
assert swagger_object_type in (openapi.Schema, openapi.Parameter, openapi.Items)
|
||||
assert not isinstance(field, openapi.SwaggerDict), "passed field is already a SwaggerDict object"
|
||||
|
||||
@@ -344,7 +344,7 @@ class SwaggerAutoSchema(ViewInspector):
|
||||
|
||||
:param description: the full description to be analyzed
|
||||
:return: summary and description
|
||||
:rtype: tuple[str,str]
|
||||
:rtype: (str,str)
|
||||
"""
|
||||
# https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings
|
||||
summary = None
|
||||
@@ -362,7 +362,7 @@ class SwaggerAutoSchema(ViewInspector):
|
||||
"""Return an operation summary and description determined from the view's docstring.
|
||||
|
||||
:return: summary and description
|
||||
:rtype: tuple[str,str]
|
||||
:rtype: (str,str)
|
||||
"""
|
||||
description = self.overrides.get('operation_description', None)
|
||||
summary = self.overrides.get('operation_summary', None)
|
||||
|
||||
Reference in New Issue
Block a user