From bfeba3302e995fdba373603533fce54bf788adff Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Fri, 6 May 2022 00:25:41 -0400 Subject: many pydoc formatting cleanups, added deprecated decorator and replaced ad-hoc messages with consistent decorator --- python/interaction.py | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) (limited to 'python/interaction.py') diff --git a/python/interaction.py b/python/interaction.py index 978de6b2..ba9da5a3 100644 --- a/python/interaction.py +++ b/python/interaction.py @@ -1056,12 +1056,9 @@ 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 :py:math:`BinaryView.show_html_report` \ + applications. This API doesn't support hyperlinking into the BinaryView, use the :py:meth:`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. - :param str contents: HTML contents to display :param str plaintext: Plain text version to display (used on the command-line) :rtype: None @@ -1201,12 +1198,12 @@ def get_open_filename_input(prompt: str, ext: str = "") -> Optional[str]: """ ``get_open_filename_input`` prompts the user for a file name to open - .. note:: This API function differently on the command-line vs the UI. In the UI a pop-up is used. On the command-line \ + .. note:: This API functions 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. The UI uses the native window pop-up for file selection. Multiple file selection groups can be included if separated by two semicolons. Multiple file wildcards may be specified by using a space within the parenthesis. - Also, a simple selector of "*.extension" by itself may also be used instead of specifying the description. + Also, a simple selector of "\*.extension" by itself may also be used instead of specifying the description. :param str prompt: Prompt to display. :param str ext: Optional, file extension -- cgit v1.3.1