summaryrefslogtreecommitdiff
path: root/python/binaryview.py
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2017-07-11 17:57:26 -0400
committerJordan Wiens <jordan@psifertex.com>2017-07-11 17:57:26 -0400
commit00961d39ab43a1476b449b858d00f8e43f0928cd (patch)
treecfb3cbe81c062fc27ef597591a88fee01a068b77 /python/binaryview.py
parente5be1fc1b4f36a62226e00fa03a2726779026a3b (diff)
add documentation to shutdown
Diffstat (limited to 'python/binaryview.py')
-rw-r--r--python/binaryview.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index c0ac0abc..ad583966 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -115,6 +115,10 @@ class AnalysisCompletionEvent(object):
pass
def cancel(self):
+ """
+ .. warning: This method should only be used when the system is being
+ shut down and no further analysis should be done afterward.
+ """
self.callback = self._empty_callback
core.BNCancelAnalysisCompletionEvent(self.handle)