From 3c753e953da1fec341010170042c35fe39c3b0f9 Mon Sep 17 00:00:00 2001 From: ZhiQiang Fan Date: Mon, 19 Oct 2015 01:48:38 -0600 Subject: [PATCH] fix typos in docstring patch I4804c45c2ba69982163503ba5d9d4eba86f904fe has some typos in docstring: * :param *args: should be :param args:, there is no need to use the leading star, meanwhile the star has special meaning in doc string which need to appear by pairs. * :param for this ceiloclient, actually this phase is part of last param's help string Change-Id: Ib7b964ffe064b805130953f6a6abca354d9eef79 --- ceilometerclient/client.py | 12 ++++++------ ceilometerclient/v1/client.py | 2 +- ceilometerclient/v2/client.py | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/ceilometerclient/client.py b/ceilometerclient/client.py index 3730978..8254c48 100644 --- a/ceilometerclient/client.py +++ b/ceilometerclient/client.py @@ -374,15 +374,15 @@ def get_client(version, **kwargs): * service_type: The default service_type for URL discovery * service_name: The default service_name for URL discovery * interface: The default interface for URL discovery - (Default: public) + (Default: public) * region_name: The default region_name for URL discovery * endpoint_override: Always use this endpoint URL for requests - for this ceiloclient + for this ceiloclient * auth: An auth plugin to use instead of the session one * user_agent: The User-Agent string to set - (Default is python-ceilometer-client) + (Default is python-ceilometer-client) * connect_retries: the maximum number of retries that should be - attempted for connection errors + attempted for connection errors * logger: A logging object or (DEPRECATED): @@ -489,8 +489,8 @@ def record_time(times, enabled, *args): :type times: list :param enabled: Whether timing is enabled. :type enabled: bool - :param *args: Other data to be stored besides time data, these args - will be joined to a string. + :param args: Other data to be stored besides time data, these args + will be joined to a string. """ if not enabled: yield diff --git a/ceilometerclient/v1/client.py b/ceilometerclient/v1/client.py index 8c382de..b56e010 100644 --- a/ceilometerclient/v1/client.py +++ b/ceilometerclient/v1/client.py @@ -29,7 +29,7 @@ class Client(object): (Default: public) :param str region_name: The default region_name for URL discovery :param str endpoint_override: Always use this endpoint URL for requests - :param for this ceiloclient + for this ceiloclient :param auth: An auth plugin to use instead of the session one :type auth: keystoneclient.auth.base.BaseAuthPlugin :param str user_agent: The User-Agent string to set diff --git a/ceilometerclient/v2/client.py b/ceilometerclient/v2/client.py index 16f1c35..b3272a1 100644 --- a/ceilometerclient/v2/client.py +++ b/ceilometerclient/v2/client.py @@ -42,7 +42,7 @@ class Client(object): (Default: public) :param str region_name: The default region_name for URL discovery :param str endpoint_override: Always use this endpoint URL for requests - :param for this ceiloclient + for this ceiloclient :param auth: An auth plugin to use instead of the session one :type auth: keystoneclient.auth.base.BaseAuthPlugin :param str user_agent: The User-Agent string to set