Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
antusus committed Feb 11, 2022
1 parent 6e4ec87 commit 2fb6ebd
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion boxsdk/object/upload_session.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ def commit(
:param etag:
If specified, instruct the Box API to delete the folder only if the current version's etag matches.
:returns:
The newly-uploaded file object or None if commit failed
The newly-uploaded file object or None if commit was not processed
"""
body = {}
if file_attributes is not None:
Expand Down
8 changes: 4 additions & 4 deletions boxsdk/util/chunked_uploader.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ def __init__(self, upload_session: 'UploadSession', content_stream: IO, file_siz

def start(self) -> Optional['File']:
"""
Starts the process of chunk uploading a file. Should return file. If commit fails may return None.
Starts the process of chunk uploading a file. Should return file. If commit was not processed will return None.
You can call ChunkedUploader.resume to retry committing upload.
:returns:
An uploaded :class:`File` or None if session was not commited
An uploaded :class:`File` or None if session was not processed
"""
if self._is_aborted:
raise BoxException('The upload has been previously aborted. Please retry upload with a new upload session.')
Expand All @@ -48,11 +48,11 @@ def start(self) -> Optional['File']:
def resume(self) -> Optional['File']:
"""
Resumes the process of chunk uploading a file from where upload failed.
Should return file. If commit fails may return None.
Should return file. If commit was not processed will return None.
You can call ChunkedUploader.resume to retry committing upload.
:returns:
An uploaded :class:`File` or None if session was not commited
An uploaded :class:`File` or None if session was not processed
"""
if self._is_aborted:
raise BoxException('The upload has been previously aborted. Please retry upload with a new upload session.')
Expand Down

0 comments on commit 2fb6ebd

Please sign in to comment.