summaryrefslogtreecommitdiff
path: root/python/binaryview.py
diff options
context:
space:
mode:
authorBrian Potchik <brian@vector35.com>2024-10-24 22:57:28 -0400
committerBrian Potchik <brian@vector35.com>2024-10-24 22:57:28 -0400
commit5229159a85c720743c9f792be2a40edb225ca957 (patch)
tree40397f5aa603bf7df7edbc450234be94f8025e77 /python/binaryview.py
parent7585a4e68973da8c3685525388f3da1858b725cd (diff)
Improve documentation for `update_analysis`.
Diffstat (limited to 'python/binaryview.py')
-rw-r--r--python/binaryview.py9
1 files changed, 6 insertions, 3 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index 8c056db0..d24d5412 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -4651,9 +4651,12 @@ class BinaryView:
def update_analysis(self) -> None:
"""
- ``update_analysis`` asynchronously starts the analysis running and returns immediately.
- An analysis update **must** be run after changes are made which could change analysis
- results such as adding functions.
+ ``update_analysis`` asynchronously starts the analysis process and returns immediately.
+
+ Call ``update_analysis`` after making changes that could affect the analysis results,
+ such as adding or modifying functions. This ensures that the analysis is updated to
+ reflect the latest changes. The analysis runs in the background, allowing other operations
+ to continue.
:rtype: None
"""