diff options
| author | liuyamin <liuyamin@fiberhome.com> | 2017-03-28 16:50:55 +0800 |
|---|---|---|
| committer | liuyamin <liuyamin@fiberhome.com> | 2017-03-29 09:28:46 +0800 |
| commit | 2710ff255b5d3954eebdf469587bf73bbfd48431 (patch) | |
| tree | 2904bd3efddf4a6a203bc1519dec1b80386bb719 /swiftclient/utils.py | |
| parent | b404df9abad6d2c4611adee17fd9c33599cd6903 (diff) | |
| download | python-swiftclient-2710ff255b5d3954eebdf469587bf73bbfd48431.tar.gz | |
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
Diffstat (limited to 'swiftclient/utils.py')
| -rw-r--r-- | swiftclient/utils.py | 2 |
1 files changed, 1 insertions, 1 deletions
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 """ |