summaryrefslogtreecommitdiff
path: root/keystoneclient/auth/base.py
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2014-12-02 01:46:24 +0000
committerGerrit Code Review <review@openstack.org>2014-12-02 01:46:24 +0000
commit41afe3c963fa01f61b67c44e572eee34b0972382 (patch)
tree0b01d3b087879c6a1135420df4040d7f67e3a9f1 /keystoneclient/auth/base.py
parent4a49d970b06068b1ef26e7cc1f7dab3984da2ed4 (diff)
parent3f1ba9f007528a7ddad7cb53ef75f7bb1026a4d1 (diff)
downloadpython-keystoneclient-41afe3c963fa01f61b67c44e572eee34b0972382.tar.gz
Merge "Docstring cleanup for return type"
Diffstat (limited to 'keystoneclient/auth/base.py')
-rw-r--r--keystoneclient/auth/base.py23
1 files changed, 14 insertions, 9 deletions
diff --git a/keystoneclient/auth/base.py b/keystoneclient/auth/base.py
index 68d7b48..1f4ce29 100644
--- a/keystoneclient/auth/base.py
+++ b/keystoneclient/auth/base.py
@@ -67,7 +67,8 @@ class BaseAuthPlugin(object):
Returning None will indicate that no token was able to be retrieved.
:param session: A session object so the plugin can make HTTP calls.
- :return string: A token to use.
+ :return: A token to use.
+ :rtype: string
"""
def get_endpoint(self, session, **kwargs):
@@ -86,8 +87,9 @@ class BaseAuthPlugin(object):
:param Session session: The session object that the auth_plugin
belongs to.
- :returns string: The base URL that will be used to talk to the
- required service or None if not available.
+ :returns: The base URL that will be used to talk to the required
+ service or None if not available.
+ :rtype: string
"""
def invalidate(self):
@@ -99,9 +101,10 @@ class BaseAuthPlugin(object):
returned to indicate that the token may have been revoked or is
otherwise now invalid.
- :returns bool: True if there was something that the plugin did to
- invalidate. This means that it makes sense to try again.
- If nothing happens returns False to indicate give up.
+ :returns: True if there was something that the plugin did to
+ invalidate. This means that it makes sense to try again. If
+ nothing happens returns False to indicate give up.
+ :rtype: bool
"""
return False
@@ -111,8 +114,9 @@ class BaseAuthPlugin(object):
This list may be used to generate CLI or config arguments.
- :returns list: A list of Param objects describing available plugin
- parameters.
+ :returns: A list of Param objects describing available plugin
+ parameters.
+ :rtype: list
"""
return []
@@ -201,7 +205,8 @@ class BaseAuthPlugin(object):
:param conf: An oslo.config conf object.
:param string group: The group name that options should be read from.
- :returns plugin: An authentication Plugin.
+ :returns: An authentication Plugin.
+ :rtype: plugin:
"""
plugin_opts = cls.get_options()