summaryrefslogtreecommitdiff
path: root/keystoneclient/common
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/common
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/common')
-rw-r--r--keystoneclient/common/cms.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/keystoneclient/common/cms.py b/keystoneclient/common/cms.py
index 1c343f6..4cc843b 100644
--- a/keystoneclient/common/cms.py
+++ b/keystoneclient/common/cms.py
@@ -132,8 +132,10 @@ def cms_verify(formatted, signing_cert_file_name, ca_file_name,
inform=PKI_ASN1_FORM):
"""Verifies the signature of the contents IAW CMS syntax.
- :raises: subprocess.CalledProcessError
- :raises: CertificateConfigError if certificate is not configured properly.
+ :raises subprocess.CalledProcessError:
+ :raises keystoneclient.exceptions.CertificateConfigError: if certificate
+ is not configured
+ properly.
"""
_ensure_subprocess()
if isinstance(formatted, six.string_types):