From 87b9588ec9068ba3abd2de654d93587e8c232f2e Mon Sep 17 00:00:00 2001 From: MMurape Date: Thu, 20 Mar 2025 22:07:02 +0200 Subject: [PATCH] [Python] fixed docstring to comply with PEP 287 - reStructuredText (reST) format. TIP: see https://www.sphinx-doc.org/en/master/usage/domains/python.html#info-field-lists --- src/main/resources/handlebars/python/api.mustache | 8 ++++---- src/main/resources/handlebars/python/api_client.mustache | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/main/resources/handlebars/python/api.mustache b/src/main/resources/handlebars/python/api.mustache index 61a05ca961..63228fd2bb 100644 --- a/src/main/resources/handlebars/python/api.mustache +++ b/src/main/resources/handlebars/python/api.mustache @@ -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. """ @@ -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. """ diff --git a/src/main/resources/handlebars/python/api_client.mustache b/src/main/resources/handlebars/python/api_client.mustache index 5c62fff24f..8b60be6f40 100644 --- a/src/main/resources/handlebars/python/api_client.mustache +++ b/src/main/resources/handlebars/python/api_client.mustache @@ -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,