TrivialFix: Correct reST field lists in docstrings

Most common format for documenting arguments is reST field, the incorrect
docstring will cause a Sphinx warning to be generated and caused the documentation
to be improperly rendered.

[1] http://sphinx-doc.org/domains.html#info-field-lists

The old patch will be abandon: https://review.openstack.org/#/c/490432/

Change-Id: Icd84ad664dad2ea116864735dbaf388d1774c42a
This commit is contained in:
yfzhao 2017-09-26 10:02:26 +08:00
parent 71680b2059
commit 29d169a7a9
6 changed files with 13 additions and 13 deletions

View File

@ -568,12 +568,12 @@ class Store(glance_store.driver.Store):
where to find the image file, and returns a tuple of generator
(for reading the image file) and image_size
:param location `glance_store.location.Location` object, supplied
:param location: `glance_store.location.Location` object, supplied
from glance_store.location.get_location_from_uri()
:param offset: offset to start reading
:param chunk_size: size to read, or None to get all the image
:param context: Request context
:raises `glance_store.exceptions.NotFound` if image does not exist
:raises: `glance_store.exceptions.NotFound` if image does not exist
"""
loc = location.store_location
@ -638,9 +638,9 @@ class Store(glance_store.driver.Store):
:param context: The request context
:param verifier: An object used to verify signatures for images
:retval tuple of URL in backing store, bytes written, checksum
:returns: tuple of URL in backing store, bytes written, checksum
and a dictionary with storage system specific information
:raises `glance_store.exceptions.Duplicate` if the image already
:raises: `glance_store.exceptions.Duplicate` if the image already
existed
"""
@ -745,11 +745,11 @@ class Store(glance_store.driver.Store):
Takes a `glance_store.location.Location` object that indicates
where to find the image file to delete
:location `glance_store.location.Location` object, supplied
:param location: `glance_store.location.Location` object, supplied
from glance_store.location.get_location_from_uri()
:raises NotFound if image does not exist
:raises Forbidden if cannot delete because of permissions
:raises: NotFound if image does not exist
:raises: Forbidden if cannot delete because of permissions
"""
loc = location.store_location
self._check_context(context)

View File

@ -657,7 +657,7 @@ class Store(glance_store.driver.Store):
:param image_size: The size of the image data to write, in bytes
:param verifier: An object used to verify signatures for images
:retval: tuple of URL in backing store, bytes written, checksum
:returns: tuple of URL in backing store, bytes written, checksum
and a dictionary with storage system specific information
:raises: `glance_store.exceptions.Duplicate` if the image already
existed

View File

@ -353,7 +353,7 @@ class Store(driver.Store):
:param image_name: Image's name
:retval: `glance_store.rbd.StoreLocation` object
:returns: `glance_store.rbd.StoreLocation` object
"""
librbd = rbd.RBD()
features = conn.conf_get('rbd_default_features')
@ -443,7 +443,7 @@ class Store(driver.Store):
:param image_size: The size of the image data to write, in bytes
:param verifier: An object used to verify signatures for images
:retval: tuple of URL in backing store, bytes written, checksum
:returns: tuple of URL in backing store, bytes written, checksum
and a dictionary with storage system specific information
:raises: `glance_store.exceptions.Duplicate` if the image already
existed

View File

@ -349,7 +349,7 @@ class Store(glance_store.driver.Store):
:param image_size: The size of the image data to write, in bytes
:param verifier: An object used to verify signatures for images
:retval: tuple of URL in backing store, bytes written, and checksum
:returns: tuple of URL in backing store, bytes written, and checksum
:raises: `glance_store.exceptions.Duplicate` if the image already
existed
"""

View File

@ -545,7 +545,7 @@ class Store(glance_store.Store):
:param image_file: The image data to write, as a file-like object
:param image_size: The size of the image data to write, in bytes
:param verifier: An object used to verify signatures for images
:retval tuple of URL in backing store, bytes written, checksum
:returns: tuple of URL in backing store, bytes written, checksum
and a dictionary with storage system specific information
:raises: `glance.common.exceptions.Duplicate` if the image already
existed

View File

@ -136,7 +136,7 @@ class Store(capabilities.StoreCapability):
:param image_file: The image data to write, as a file-like object
:param image_size: The size of the image data to write, in bytes
:retval: tuple of URL in backing store, bytes written, checksum
:returns: tuple of URL in backing store, bytes written, checksum
and a dictionary with storage system specific information
:raises: `glance_store.exceptions.Duplicate` if the image already
existed