Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Python] fixed docstring to comply with PEP 287 #1338

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Python] fixed docstring to comply with PEP 287 #1338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/main/resources/handlebars/python/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ class {{classname}}(object):
{{/sortParamsByRequiredFlag}}
>>> result = thread.get()

:param async_req bool
:param bool async_req:
{{#parameters}}
:param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}}
{{/parameters}}
:return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}}
:return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}}.
If the method is called asynchronously,
returns the request thread.
"""
Expand All @@ -74,11 +74,11 @@ class {{classname}}(object):
{{/sortParamsByRequiredFlag}}
>>> result = thread.get()

:param async_req bool
:param bool async_req:
{{#parameters}}
:param {{dataType}} {{paramName}}:{{#description}} {{{description}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/optional}}
{{/parameters}}
:return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}}
:return: {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}None{{/returnType}}.
If the method is called asynchronously,
returns the request thread.
"""
Expand Down
8 changes: 4 additions & 4 deletions src/main/resources/handlebars/python/api_client.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,13 +294,13 @@ class ApiClient(object):
:param header_params: Header parameters to be
placed in the request header.
:param body: Request body.
:param post_params dict: Request post form parameters,
:param dict post_params: Request post form parameters,
for `application/x-www-form-urlencoded`, `multipart/form-data`.
:param auth_settings list: Auth Settings names for the request.
:param list auth_settings: Auth Settings names for the request.
:param response: Response data type.
:param files dict: key -> filename, value -> filepath,
:param dict files: key -> filename, value -> filepath,
for `multipart/form-data`.
:param async_req bool: execute request asynchronously
:param bool async_req: execute request asynchronously
:param _return_http_data_only: response data without head status code
and headers
:param collection_formats: dict of collection formats for path, query,
Expand Down