Skip to content

Commit

Permalink
chore(streaming): docstring for stream_file refget mode
Browse files Browse the repository at this point in the history
  • Loading branch information
davidlougheed committed Aug 20, 2024
1 parent c67fbec commit f4c3ca0
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion bento_lib/streaming/file.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ async def stream_file(
big-endian encoded) of the stream.
:param file_size: The whole file's size, if already known. If this has already been calculated/stored, this saves a
stat() call.
:param refget_mode: TODO
:param refget_mode: Whether to raise Refget-compliant errors, rather than correct errors (GA4GH...), i.e.,
400 instead of 416 for past-EOF errors.
"""

final_file_size: int = file_size or (await aiofiles.os.stat(path)).st_size
Expand Down

0 comments on commit f4c3ca0

Please sign in to comment.