diff options
| author | Brant Knudson <bknudson@us.ibm.com> | 2014-10-12 19:11:39 -0500 |
|---|---|---|
| committer | Brant Knudson <bknudson@us.ibm.com> | 2014-10-15 12:24:52 -0500 |
| commit | 3f1ba9f007528a7ddad7cb53ef75f7bb1026a4d1 (patch) | |
| tree | e0f520f36ec6312e0cf3b3f417fcb197ebb1e490 /keystoneclient/auth/base.py | |
| parent | 8b267842a701970d4e1aae2f115afe4d73bc5ee6 (diff) | |
| download | python-keystoneclient-3f1ba9f007528a7ddad7cb53ef75f7bb1026a4d1.tar.gz | |
Docstring cleanup for return type
The :returns: directive doesn't take an argument. To specify the
return type, use the :rtype: directive.
Change-Id: I3aaab824792333b3f75a10af92f5b712cc9b4ff6
Diffstat (limited to 'keystoneclient/auth/base.py')
| -rw-r--r-- | keystoneclient/auth/base.py | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/keystoneclient/auth/base.py b/keystoneclient/auth/base.py index 66e6a18..a766a0b 100644 --- a/keystoneclient/auth/base.py +++ b/keystoneclient/auth/base.py @@ -64,7 +64,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): @@ -83,8 +84,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): @@ -96,9 +98,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 @@ -108,8 +111,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 [] @@ -198,7 +202,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() |
