summaryrefslogtreecommitdiff
path: root/keystoneclient/adapter.py
diff options
context:
space:
mode:
authorBrant Knudson <bknudson@us.ibm.com>2014-10-11 16:20:54 -0500
committerBrant Knudson <bknudson@us.ibm.com>2014-12-04 19:04:15 -0600
commit3c8d35247ebfc57663f363ba9522da27b8748262 (patch)
tree9608b4b767be52d66416f2e869a95424f3b2623e /keystoneclient/adapter.py
parentcc0c93fc0c4c5d0240a5a96c57f1fd62988ee6aa (diff)
downloadpython-keystoneclient-3c8d35247ebfc57663f363ba9522da27b8748262.tar.gz
Correct documenting constructor parameters
When the docs are rendered to HTML, any docs on __init__ are not displayed. The parameters to the constructor have to be documented on the class rather than on the __init__ method. Also, corrected other minor issues in the same areas. Change-Id: Ic56da33f6b99fe5efb636c289e3c4e1569f0c84c
Diffstat (limited to 'keystoneclient/adapter.py')
-rw-r--r--keystoneclient/adapter.py35
1 files changed, 17 insertions, 18 deletions
diff --git a/keystoneclient/adapter.py b/keystoneclient/adapter.py
index 49dd198..8f87c73 100644
--- a/keystoneclient/adapter.py
+++ b/keystoneclient/adapter.py
@@ -23,6 +23,23 @@ class Adapter(object):
state such as the service type and region_name that are only relevant to a
particular client that is using the session. An adapter provides a wrapper
of client local data around the global session object.
+
+ :param session: The session object to wrap.
+ :type session: keystoneclient.session.Session
+ :param str service_type: The default service_type for URL discovery.
+ :param str service_name: The default service_name for URL discovery.
+ :param str interface: The default interface for URL discovery.
+ :param str region_name: The default region_name for URL discovery.
+ :param str endpoint_override: Always use this endpoint URL for requests
+ for this client.
+ :param tuple version: The version that this API targets.
+ :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.
+ :param int connect_retries: the maximum number of retries that should
+ be attempted for connection errors.
+ Default None - use session default which
+ is don't retry.
"""
@utils.positional()
@@ -30,24 +47,6 @@ class Adapter(object):
interface=None, region_name=None, endpoint_override=None,
version=None, auth=None, user_agent=None,
connect_retries=None):
- """Create a new adapter.
-
- :param Session session: The session object to wrap.
- :param str service_type: The default service_type for URL discovery.
- :param str service_name: The default service_name for URL discovery.
- :param str interface: The default interface for URL discovery.
- :param str region_name: The default region_name for URL discovery.
- :param str endpoint_override: Always use this endpoint URL for requests
- for this client.
- :param tuple version: The version that this API targets.
- :param auth.BaseAuthPlugin auth: An auth plugin to use instead of the
- session one.
- :param str user_agent: The User-Agent string to set.
- :param int connect_retries: the maximum number of retries that should
- be attempted for connection errors.
- Default None - use session default which
- is don't retry.
- """
self.session = session
self.service_type = service_type
self.service_name = service_name