From 05e093efbefaa5a759977600e50ba8a97dcebb7c Mon Sep 17 00:00:00 2001 From: lingyongxu Date: Tue, 5 Sep 2017 15:27:19 +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: I54ac5a1cff963f301ac1536887f7f0866ada0d22 --- glare/objects/meta/file_utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/glare/objects/meta/file_utils.py b/glare/objects/meta/file_utils.py index 9d2633d..1883e56 100644 --- a/glare/objects/meta/file_utils.py +++ b/glare/objects/meta/file_utils.py @@ -109,7 +109,7 @@ def unpack_zip_archive_in_memory(context, af, field_name, fd): :param af: artifact object :param field_name: blob dict name where to unpack the data :param fd: zip archive - :return io.BytesIO object - simple stream of in-memory bytes + :return: io.BytesIO object - simple stream of in-memory bytes """ # Warning: usage of this function is potentially harmful, because it # doesn't limit how much data it writes to ram. Careless usage in artifact