From 94391b2730dcc2e6cfe9f26d13569b15c6d1a0ad Mon Sep 17 00:00:00 2001
From: Peter LaFosse <peter@vector35.com>
Date: Tue, 21 Mar 2023 10:33:23 -0400
Subject: Update documentation for progress callbacks to indicate they must
 return True to continue the action

---
 python/filemetadata.py | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'python/filemetadata.py')

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:
-- 
cgit v1.3.1