summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorBrian Potchik <brian@vector35.com>2024-09-05 08:09:07 -0400
committerBrian Potchik <brian@vector35.com>2024-09-05 08:09:07 -0400
commit029fa6704ad29b40cbd3265caaa8e3b03a640d12 (patch)
tree015a8d9e27088ef63cd94b99a387ef5f61680945 /python
parent3563597875113428290914767863801133383254 (diff)
Add doc note for get_linear_disassembly API.
Diffstat (limited to 'python')
-rw-r--r--python/binaryview.py6
1 files changed, 4 insertions, 2 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index 484e704f..9fa471dd 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -7234,8 +7234,10 @@ class BinaryView:
``get_linear_disassembly`` gets an iterator for all lines in the linear disassembly of the view for the given
disassembly settings.
- .. note:: linear_disassembly doesn't just return disassembly; it will return a single line from the linear view,\
- and thus will contain both data views, and disassembly.
+ .. note::
+ - linear_disassembly doesn't just return disassembly; it will return a single line from the linear view,\
+ and thus will contain both data views, and disassembly.
+ - **Warning:** In order to get deterministic output, the WaitForIL `DisassemblyOption` should be set to True.
:param DisassemblySettings settings: instance specifying the desired output formatting. Defaults to None which will use default settings.
:return: An iterator containing formatted disassembly lines.