openstack/python-swiftclient
Code Issues Proposed changes

Fix some reST field lists in docstrings

Browse Source 
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: Ic011fd3e3a8c5bafa24a3438a6ed5bb126b50e95
This commit is contained in:
liuyamin
2017-03-28 16:50:55 +08:00
parent b404df9aba
commit 2710ff255b
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
swiftclient/service.py
View File

@@ -473,7 +473,7 @@ class SwiftService(object):
or container, or an iterator for returning the results of the or container, or an iterator for returning the results of the
stat operations on a list of objects. stat operations on a list of objects.
:raises: SwiftError :raises SwiftError:
""" """
if options is not None: if options is not None:
options = dict(self._options, **options) options = dict(self._options, **options)
@@ -637,7 +637,7 @@ class SwiftService(object):
container/account, or an iterator for returning the results container/account, or an iterator for returning the results
of posts to a list of objects. of posts to a list of objects.
:raises: SwiftError :raises SwiftError:
""" """
if options is not None: if options is not None:
options = dict(self._options, **options) options = dict(self._options, **options)
@@ -1031,8 +1031,8 @@ class SwiftService(object):
'download_object' dictionary containing the results of an 'download_object' dictionary containing the results of an
individual file download. individual file download.
:raises: ClientException :raises ClientException:
:raises: SwiftError :raises SwiftError:
""" """
if options is not None: if options is not None:
options = dict(self._options, **options) options = dict(self._options, **options)
@@ -1396,8 +1396,8 @@ class SwiftService(object):
:returns: A generator for returning the results of the uploads. :returns: A generator for returning the results of the uploads.
:raises: SwiftError :raises SwiftError:
:raises: ClientException :raises ClientException:
""" """
if options is not None: if options is not None:
options = dict(self._options, **options) options = dict(self._options, **options)
@@ -2135,8 +2135,8 @@ class SwiftService(object):
'bulk_delete' dictionary containing the results of an 'bulk_delete' dictionary containing the results of an
individual delete operation. individual delete operation.
:raises: ClientException :raises ClientException:
:raises: SwiftError :raises SwiftError:
""" """
if options is not None: if options is not None:
options = dict(self._options, **options) options = dict(self._options, **options)
@@ -2504,7 +2504,7 @@ class SwiftService(object):
:returns: A generator returning the results of copying the given list :returns: A generator returning the results of copying the given list
of objects. of objects.
:raises: SwiftError :raises SwiftError:
""" """
if options is not None: if options is not None:
options = dict(self._options, **options) options = dict(self._options, **options)
@@ -2646,7 +2646,7 @@ class SwiftService(object):
:returns: A dictionary containing the capabilities of the cluster. :returns: A dictionary containing the capabilities of the cluster.
:raises: ClientException :raises ClientException:
""" """
if not refresh_cache and url in self.capabilities_cache: if not refresh_cache and url in self.capabilities_cache:
return self.capabilities_cache[url] return self.capabilities_cache[url]

2
swiftclient/utils.py
View File

@@ -84,7 +84,7 @@ def generate_temp_url(path, seconds, key, method, absolute=False,
absolute Unix time, otherwise seconds is interpreted as a relative time absolute Unix time, otherwise seconds is interpreted as a relative time
offset from current time. offset from current time.
:param prefix: if True then a prefix-based temporary URL will be generated. :param prefix: if True then a prefix-based temporary URL will be generated.
:raises: ValueError if seconds is not a whole number or path is not to :raises ValueError: if seconds is not a whole number or path is not to
an object. an object.
:return: the path portion of a temporary URL :return: the path portion of a temporary URL
""" """