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: Ic011fd3e3a8c5bafa24a3438a6ed5bb126b50e95
This commit is contained in:
parent
b404df9aba
commit
2710ff255b
swiftclient
@ -473,7 +473,7 @@ class SwiftService(object):
|
||||
or container, or an iterator for returning the results of the
|
||||
stat operations on a list of objects.
|
||||
|
||||
:raises: SwiftError
|
||||
:raises SwiftError:
|
||||
"""
|
||||
if options is not None:
|
||||
options = dict(self._options, **options)
|
||||
@ -637,7 +637,7 @@ class SwiftService(object):
|
||||
container/account, or an iterator for returning the results
|
||||
of posts to a list of objects.
|
||||
|
||||
:raises: SwiftError
|
||||
:raises SwiftError:
|
||||
"""
|
||||
if options is not None:
|
||||
options = dict(self._options, **options)
|
||||
@ -1031,8 +1031,8 @@ class SwiftService(object):
|
||||
'download_object' dictionary containing the results of an
|
||||
individual file download.
|
||||
|
||||
:raises: ClientException
|
||||
:raises: SwiftError
|
||||
:raises ClientException:
|
||||
:raises SwiftError:
|
||||
"""
|
||||
if options is not None:
|
||||
options = dict(self._options, **options)
|
||||
@ -1396,8 +1396,8 @@ class SwiftService(object):
|
||||
|
||||
:returns: A generator for returning the results of the uploads.
|
||||
|
||||
:raises: SwiftError
|
||||
:raises: ClientException
|
||||
:raises SwiftError:
|
||||
:raises ClientException:
|
||||
"""
|
||||
if options is not None:
|
||||
options = dict(self._options, **options)
|
||||
@ -2135,8 +2135,8 @@ class SwiftService(object):
|
||||
'bulk_delete' dictionary containing the results of an
|
||||
individual delete operation.
|
||||
|
||||
:raises: ClientException
|
||||
:raises: SwiftError
|
||||
:raises ClientException:
|
||||
:raises SwiftError:
|
||||
"""
|
||||
if options is not None:
|
||||
options = dict(self._options, **options)
|
||||
@ -2504,7 +2504,7 @@ class SwiftService(object):
|
||||
:returns: A generator returning the results of copying the given list
|
||||
of objects.
|
||||
|
||||
:raises: SwiftError
|
||||
:raises SwiftError:
|
||||
"""
|
||||
if options is not None:
|
||||
options = dict(self._options, **options)
|
||||
@ -2646,7 +2646,7 @@ class SwiftService(object):
|
||||
|
||||
:returns: A dictionary containing the capabilities of the cluster.
|
||||
|
||||
:raises: ClientException
|
||||
:raises ClientException:
|
||||
"""
|
||||
if not refresh_cache and url in self.capabilities_cache:
|
||||
return self.capabilities_cache[url]
|
||||
|
@ -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
|
||||
offset from current time.
|
||||
: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.
|
||||
:return: the path portion of a temporary URL
|
||||
"""
|
||||
|
Loading…
x
Reference in New Issue
Block a user