diff options
| author | Peter LaFosse <peter@vector35.com> | 2023-03-21 10:33:23 -0400 |
|---|---|---|
| committer | Peter LaFosse <peter@vector35.com> | 2023-03-21 10:33:28 -0400 |
| commit | 94391b2730dcc2e6cfe9f26d13569b15c6d1a0ad (patch) | |
| tree | 466a83843d6026ba250343bc4d0ce1225640820d /python/filemetadata.py | |
| parent | 808f72a50b6aab61ff3008fff7feb022a2abada2 (diff) | |
Update documentation for progress callbacks to indicate they must return True to continue the action
Diffstat (limited to 'python/filemetadata.py')
| -rw-r--r-- | python/filemetadata.py | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/python/filemetadata.py b/python/filemetadata.py index d7330514..95cd8f7b 100644 --- a/python/filemetadata.py +++ b/python/filemetadata.py @@ -427,6 +427,8 @@ class FileMetadata: :return: true on success, false on failure :rtype: bool + .. note:: The progress_func callback **must** return True to continue the save operation, False will abort the save operation. + .. warning:: The calling thread must not hold a lock on the BinaryView instance as this action is run on the main thread which requires the lock. :Example: |