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/contrib | |
| 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/contrib')
| -rw-r--r-- | keystoneclient/contrib/auth/v3/saml2.py | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/keystoneclient/contrib/auth/v3/saml2.py b/keystoneclient/contrib/auth/v3/saml2.py index 4ff0ef7..b255421 100644 --- a/keystoneclient/contrib/auth/v3/saml2.py +++ b/keystoneclient/contrib/auth/v3/saml2.py @@ -519,7 +519,7 @@ class ADFSUnscopedToken(_BaseSAMLPlugin): :param session :returns: True if cookie jar is nonempty, False otherwise - :raises: AttributeError in case cookies are not find anywhere + :raises AttributeError: in case cookies are not find anywhere """ try: @@ -704,11 +704,12 @@ class ADFSUnscopedToken(_BaseSAMLPlugin): :param session : a session object to send out HTTP requests. :type session: keystoneclient.session.Session - :raises: exceptions.AuthorizationFailure when HTTP response from the - ADFS server is not a valid XML ADFS security token. - :raises: exceptions.InternalServerError: If response status code is - HTTP 500 and the response XML cannot be recognized. - + :raises keystoneclient.exceptions.AuthorizationFailure: when HTTP + response from the ADFS server is not a valid XML ADFS security + token. + :raises keystoneclient.exceptions.InternalServerError: If response + status code is HTTP 500 and the response XML cannot be + recognized. """ def _get_failure(e): @@ -797,8 +798,8 @@ class ADFSUnscopedToken(_BaseSAMLPlugin): :param session : a session object to send out HTTP requests. :type session: keystoneclient.session.Session - :raises: exceptions.AuthorizationFailure: in case session object - has empty cookie jar. + :raises keystoneclient.exceptions.AuthorizationFailure: in case session + object has empty cookie jar. """ if self._cookies(session) is False: |