diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2022-01-04 23:14:52 -0500 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2022-01-04 23:16:18 -0500 |
| commit | 7c5ab2b84368e8e5ba6ab5b9d13c64cc655a3de9 (patch) | |
| tree | 81f141a01b7265e908d9c0abb85772ea3139d29b /python | |
| parent | 82d4730da75b01e9521344b7497f2238bbdef18f (diff) | |
small pydoc updtaes
Diffstat (limited to 'python')
| -rw-r--r-- | python/interaction.py | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/python/interaction.py b/python/interaction.py index f832a493..7389f023 100644 --- a/python/interaction.py +++ b/python/interaction.py @@ -1003,8 +1003,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. This API doesn't support hyperlinking into the BinaryView, use the BinaryView.show_markdown_report \ - if hyperlinking is needed. + applications. This API doesn't support hyperlinking into the BinaryView, use the \ + :py:meth:`BinaryView.show_markdown_report` API 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. @@ -1022,8 +1022,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. This API doesn't support hyperlinking into the BinaryView, use the BinaryView.show_html_report \ - if hyperlinking is needed. + applications. This API doesn't support hyperlinking into the BinaryView, use the :py:math:`BinaryView.show_html_report` \ + API 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. @@ -1040,7 +1040,9 @@ def show_html_report(title, contents, plaintext=""): def show_graph_report(title, graph): """ - ``show_graph_report`` displays a flow graph in UI applications + ``show_graph_report`` displays a flow graph in UI applications and nothing in command-line applications. \ + This API doesn't support clickable references into an existing BinaryView. Use the :py:meth:`BinaryView.show_html_report` \ + API if hyperlinking is needed. .. note:: This API function will have no effect outside the UI. |