Fix some reST field lists in docstrings
Probably the most common format for documenting arguments is reST field lists [1]. This change updates some docstrings to comply with the field lists syntax. [1] http://sphinx-doc.org/domains.html#info-field-lists Change-Id: I0300dbac6dc02681cec2725b3c44a7dd1bfd7b4e
This commit is contained in:
@@ -136,7 +136,7 @@ class ContextMiddleware(BaseContextMiddleware):
|
||||
of the req object.
|
||||
|
||||
:param req: wsgi request object that will be given the context object
|
||||
:raises: webob.exc.HTTPUnauthorized: when value of the
|
||||
:raises webob.exc.HTTPUnauthorized: when value of the
|
||||
X-Identity-Status header is not
|
||||
'Confirmed' and anonymous access
|
||||
is disallowed
|
||||
|
||||
@@ -93,7 +93,7 @@ class VersionNegotiationFilter(wsgi.Middleware):
|
||||
|
||||
:param subject: The string to check
|
||||
:returns: version found in the subject
|
||||
:raises: ValueError if no acceptable version could be found
|
||||
:raises ValueError: if no acceptable version could be found
|
||||
"""
|
||||
if self.allowed_versions is None:
|
||||
self.allowed_versions = self._get_allowed_versions()
|
||||
|
||||
@@ -34,7 +34,7 @@ class BaseController(object):
|
||||
:param request: The WSGI/Webob Request object
|
||||
:param image_id: The opaque image identifier
|
||||
|
||||
:raises: HTTPNotFound if image does not exist
|
||||
:raises HTTPNotFound: if image does not exist
|
||||
"""
|
||||
context = request.context
|
||||
try:
|
||||
|
||||
@@ -135,7 +135,7 @@ class OVAImageExtractor(object):
|
||||
:param ova: a file object containing the OVA file
|
||||
:returns: a tuple of extracted disk file object and dictionary of
|
||||
properties parsed from the OVF file
|
||||
:raises: RuntimeError for malformed OVA and OVF files
|
||||
:raises RuntimeError: an error for malformed OVA and OVF files
|
||||
"""
|
||||
with tarfile.open(fileobj=ova) as tar_file:
|
||||
filenames = tar_file.getnames()
|
||||
@@ -164,7 +164,7 @@ class OVAImageExtractor(object):
|
||||
|
||||
:param ovf: a file object containing the OVF file
|
||||
:returns: a tuple of disk filename and a properties dictionary
|
||||
:raises: RuntimeError for malformed OVF file
|
||||
:raises RuntimeError: an error for malformed OVF file
|
||||
"""
|
||||
|
||||
def _get_namespace_and_tag(tag):
|
||||
|
||||
@@ -735,7 +735,7 @@ def load_paste_app(app_name, flavor=None, conf_file=None):
|
||||
:param flavor: name of the variant of the application to load
|
||||
:param conf_file: path to the paste config file
|
||||
|
||||
:raises: RuntimeError when config file cannot be located or application
|
||||
:raises RuntimeError: when config file cannot be located or application
|
||||
cannot be loaded from config file
|
||||
"""
|
||||
# append the deployment flavor to the application name,
|
||||
|
||||
@@ -652,7 +652,7 @@ def evaluate_filter_op(value, operator, threshold):
|
||||
:param operator: any supported filter operation
|
||||
:param threshold: to compare value against, as right side of expression
|
||||
|
||||
:raises: InvalidFilterOperatorValue if an unknown operator is provided
|
||||
:raises InvalidFilterOperatorValue: if an unknown operator is provided
|
||||
|
||||
:returns: boolean result of applied comparison
|
||||
|
||||
|
||||
@@ -65,7 +65,7 @@ def image_update(client, image_id, values, purge_props=False, from_state=None,
|
||||
"""
|
||||
Set the given properties on an image and update it.
|
||||
|
||||
:raises: ImageNotFound if image does not exist.
|
||||
:raises ImageNotFound: if image does not exist.
|
||||
"""
|
||||
return client.image_update(values=values,
|
||||
image_id=image_id,
|
||||
|
||||
Reference in New Issue
Block a user