From 94391b2730dcc2e6cfe9f26d13569b15c6d1a0ad Mon Sep 17 00:00:00 2001 From: Peter LaFosse 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/binaryview.py | 2 ++ 1 file changed, 2 insertions(+) (limited to 'python/binaryview.py') diff --git a/python/binaryview.py b/python/binaryview.py index b7cb1a27..2b202735 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -1195,6 +1195,8 @@ class BinaryViewType(metaclass=_BinaryViewTypeMetaclass): :return: returns a :py:class:`BinaryView` object for the given filename or ``None`` :rtype: :py:class:`BinaryView` or ``None`` + .. 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: -- cgit v1.3.1