diff options
author | Brant Knudson <bknudson@us.ibm.com> | 2014-10-12 19:41:38 -0500 |
---|---|---|
committer | Brant Knudson <bknudson@us.ibm.com> | 2014-10-18 17:59:08 -0500 |
commit | 14a6d80116c5d9410d1c52bee833beb10837df28 (patch) | |
tree | 00c93bc0b0566ec25b7577062c3198e9209eb9fa /keystoneclient/adapter.py | |
parent | 8b267842a701970d4e1aae2f115afe4d73bc5ee6 (diff) | |
download | python-keystoneclient-14a6d80116c5d9410d1c52bee833beb10837df28.tar.gz |
Cleanup docs - raises class
The argument to the :raises: directive is the class name. If the
class name is a valid reference it's rendered as a link to the
class. This change cleans up the :raises: directives to use the
reference correctly and use a valid class reference.
Change-Id: I84188b60de0ab4c6b5b2fb5a203c43bfde094707
Diffstat (limited to 'keystoneclient/adapter.py')
-rw-r--r-- | keystoneclient/adapter.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/keystoneclient/adapter.py b/keystoneclient/adapter.py index 3d65d78..ddd61be 100644 --- a/keystoneclient/adapter.py +++ b/keystoneclient/adapter.py @@ -93,7 +93,8 @@ class Adapter(object): on the session. (optional) :type auth: :class:`keystoneclient.auth.base.BaseAuthPlugin` - :raises AuthorizationFailure: if a new token fetch fails. + :raises keystoneclient.exceptions.AuthorizationFailure: if a new token + fetch fails. :returns string: A valid token. """ @@ -106,7 +107,8 @@ class Adapter(object): the session. (optional) :type auth: :class:`keystoneclient.auth.base.BaseAuthPlugin` - :raises MissingAuthPlugin: if a plugin is not available. + :raises keystoneclient.exceptions.MissingAuthPlugin: if a plugin is not + available. :returns string: An endpoint if available or None. """ |