From 5229159a85c720743c9f792be2a40edb225ca957 Mon Sep 17 00:00:00 2001 From: Brian Potchik Date: Thu, 24 Oct 2024 22:57:28 -0400 Subject: Improve documentation for `update_analysis`. --- python/binaryview.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'python/binaryview.py') 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 """ -- cgit v1.3.1