From 2710ff255b5d3954eebdf469587bf73bbfd48431 Mon Sep 17 00:00:00 2001 From: liuyamin Date: Tue, 28 Mar 2017 16:50:55 +0800 Subject: [PATCH] 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 --- swiftclient/service.py | 20 ++++++++++---------- swiftclient/utils.py | 2 +- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/swiftclient/service.py b/swiftclient/service.py index b2b00c6..ce0c4fc 100644 --- a/swiftclient/service.py +++ b/swiftclient/service.py @@ -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] diff --git a/swiftclient/utils.py b/swiftclient/utils.py index 47856c2..08cd7b2 100644 --- a/swiftclient/utils.py +++ b/swiftclient/utils.py @@ -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 """