summaryrefslogtreecommitdiff
path: root/python/__init__.py
diff options
context:
space:
mode:
authorPeter LaFosse <peter@vector35.com>2023-03-21 10:33:23 -0400
committerPeter LaFosse <peter@vector35.com>2023-03-21 10:33:28 -0400
commit94391b2730dcc2e6cfe9f26d13569b15c6d1a0ad (patch)
tree466a83843d6026ba250343bc4d0ce1225640820d /python/__init__.py
parent808f72a50b6aab61ff3008fff7feb022a2abada2 (diff)
Update documentation for progress callbacks to indicate they must return True to continue the action
Diffstat (limited to 'python/__init__.py')
-rw-r--r--python/__init__.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/python/__init__.py b/python/__init__.py
index 1b36b2db..1fcdb77a 100644
--- a/python/__init__.py
+++ b/python/__init__.py
@@ -318,6 +318,8 @@ def load(*args, **kwargs) -> BinaryView:
:rtype: :py:class:`BinaryView`
:raises Exception: When a BinaryView could not be created
+ .. note:: The progress_func callback **must** return True to continue the load operation, False will abort the load operation.
+
:Example:
>>> from binaryninja import *
>>> with load("/bin/ls") as bv: