summaryrefslogtreecommitdiff
path: root/keystoneclient/httpclient.py
diff options
context:
space:
mode:
authorBrant Knudson <bknudson@us.ibm.com>2014-10-12 19:41:38 -0500
committerBrant Knudson <bknudson@us.ibm.com>2014-10-18 17:59:08 -0500
commit14a6d80116c5d9410d1c52bee833beb10837df28 (patch)
tree00c93bc0b0566ec25b7577062c3198e9209eb9fa /keystoneclient/httpclient.py
parent8b267842a701970d4e1aae2f115afe4d73bc5ee6 (diff)
downloadpython-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/httpclient.py')
-rw-r--r--keystoneclient/httpclient.py7
1 files changed, 4 insertions, 3 deletions
diff --git a/keystoneclient/httpclient.py b/keystoneclient/httpclient.py
index ce49dc4..4705086 100644
--- a/keystoneclient/httpclient.py
+++ b/keystoneclient/httpclient.py
@@ -364,9 +364,10 @@ class HTTPClient(baseclient.Client, base.BaseAuthPlugin):
self.management_url from the details provided in the token.
:returns: ``True`` if authentication was successful.
- :raises: AuthorizationFailure if unable to authenticate or validate
- the existing authorization token
- :raises: ValueError if insufficient parameters are used.
+ :raises keystoneclient.exceptions.AuthorizationFailure: if unable to
+ authenticate or validate the existing authorization token
+ :raises keystoneclient.exceptions.ValueError: if insufficient
+ parameters are used.
If keyring is used, token is retrieved from keyring instead.
Authentication will only be necessary if any of the following