summaryrefslogtreecommitdiff
path: root/python/interaction.py
diff options
context:
space:
mode:
authorPeter LaFosse <peter@vector35.com>2019-02-19 16:13:27 -0500
committerPeter LaFosse <peter@vector35.com>2019-02-19 16:14:23 -0500
commitbfd54b61fc1a2515995f7492b05dc93f93c913b8 (patch)
tree0feffef6cce322f159a2a348e5406106c8f053ad /python/interaction.py
parent7bf7ef581aa8a572370a9929a1425c3d8d72a40d (diff)
Fix documentation for show_html_report and show_markdown_report
Diffstat (limited to 'python/interaction.py')
-rw-r--r--python/interaction.py8
1 files changed, 4 insertions, 4 deletions
diff --git a/python/interaction.py b/python/interaction.py
index c01dd238..e9528397 100644
--- a/python/interaction.py
+++ b/python/interaction.py
@@ -643,8 +643,8 @@ def show_plain_text_report(title, contents):
def show_markdown_report(title, contents, plaintext=""):
"""
``show_markdown_report`` displays the markdown contents in UI applications and plaintext in command-line
- applications. Markdown reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows:
- ``binaryninja://?expr='_start'`` Where ``expr=`` specifies an expression parsable by the `parse_expression` API.
+ applications. This API doesn't support hyperlinking into the BinaryView, use the BinaryView.show_markdown_report
+ if hyperlinking is needed.
Note: This API function differently on the command-line vs the UI. In the UI a pop-up is used. On the command-line
a simple text prompt is used.
@@ -662,8 +662,8 @@ def show_markdown_report(title, contents, plaintext=""):
def show_html_report(title, contents, plaintext=""):
"""
``show_html_report`` displays the HTML contents in UI applications and plaintext in command-line
- applications. HTML reports support hyperlinking into the BinaryView. Hyperlinks can be specified as follows:
- ``binaryninja://?expr='_start'`` Where ``expr=`` specifies an expression parsable by the `parse_expression` API.
+ applications. This API doesn't support hyperlinking into the BinaryView, use the BinaryView.show_html_report
+ if hyperlinking is needed.
Note: This API function differently on the command-line vs the UI. In the UI a pop-up is used. On the command-line
a simple text prompt is used.