x
/
glare
Code Issues Proposed changes

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
This commit is contained in:
lingyongxu 2017-09-05 15:27:19 +08:00 committed by Lingyong Xu
parent 9b9592ea1e
commit 05e093efbe
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
glare/objects/meta/file_utils.py
View File

@ -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