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/client.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/client.py')
-rw-r--r-- | keystoneclient/client.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/keystoneclient/client.py b/keystoneclient/client.py index c58009b..8b6a6b0 100644 --- a/keystoneclient/client.py +++ b/keystoneclient/client.py @@ -36,8 +36,10 @@ def Client(version=None, unstable=False, session=None, **kwargs): :returns: New keystone client object (keystoneclient.v2_0.Client or keystoneclient.v3.Client). - :raises: DiscoveryFailure if the server's response is invalid - :raises: VersionNotAvailable if a suitable client cannot be found. + :raises keystoneclient.exceptions.DiscoveryFailure: if the server's + response is invalid + :raises keystoneclient.exceptions.VersionNotAvailable: if a suitable client + cannot be found. """ if not session: session = client_session.Session.construct(kwargs) |