summaryrefslogtreecommitdiff
path: root/python/filemetadata.py
diff options
context:
space:
mode:
Diffstat (limited to 'python/filemetadata.py')
-rw-r--r--python/filemetadata.py2
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: