add missing documentation for interaction APIs and some normalization of phrasing. Resolves #5317

2 files changed, 13 insertions, 10 deletions

diff --git a/python/binaryview.py b/python/binaryview.py
index 9ef7a913..43eda87f 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -8833,7 +8833,7 @@ class BinaryView:
 		``show_graph_report`` displays a :py:class:`FlowGraph` object `graph` in a new tab with ``title``.
 
 		:param title: Title of the graph
-		:type title: Plain text string title
+		:type title: Text string title of the tab
 		:param graph: The graph you wish to display
 		:type graph: :py:class:`FlowGraph` object
 		"""
@@ -8844,7 +8844,7 @@ class BinaryView:
 		``get_address_input`` Gets a virtual address via a prompt displayed to the user
 
 		:param prompt: Prompt for the dialog
-		:param title: Display title, if displayed via the UI
+		:param title: Window title, if used in the UI
 		:param current_address: Optional current address, for relative inputs
 		:return: The value entered by the user, if one was entered
 		"""
diff --git a/python/interaction.py b/python/interaction.py
index c767af7c..c3bfb3a2 100644
--- a/python/interaction.py
+++ b/python/interaction.py
@@ -1062,8 +1062,8 @@ def show_plain_text_report(title, contents):
 	.. 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.
 
-	:param str title: title to display in the UI pop-up
-	:param str contents: plaintext contents to display
+	:param str title: Title to display in the tab
+	:param str contents: Plaintext contents to display
 	:rtype: None
 	:Example:
 		>>> show_plain_text_report("title", "contents")
@@ -1081,6 +1081,7 @@ def show_markdown_report(title, contents, plaintext=""):
 	.. 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 title: title to display in the tab
 	:param str contents: markdown contents to display
 	:param str plaintext: Plain text version to display (used on the command-line)
 	:rtype: None
@@ -1097,6 +1098,7 @@ def show_html_report(title, contents, plaintext=""):
 	applications. This API doesn't support hyperlinking into the BinaryView, use the :py:meth:`BinaryView.show_html_report` \
 	API if hyperlinking is needed.
 
+	:param str title: Title to display in the tab
 	:param str contents: HTML contents to display
 	:param str plaintext: Plain text version to display (used on the command-line)
 	:rtype: None
@@ -1115,6 +1117,7 @@ def show_graph_report(title, graph):
 
 	.. note:: This API function will have no effect outside the UI.
 
+	:param str title: Title to display in the tab
 	:param FlowGraph graph: Flow graph to display
 	:rtype: None
 	"""
@@ -1144,9 +1147,9 @@ def get_text_line_input(prompt, title):
 	.. 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 prompt: String to prompt with.
-	:param str title: Title of the window when executed in the UI.
-	:rtype: str containing the input without trailing newline character.
+	:param str prompt: String to prompt with
+	:param str title: Title of the window when executed in the UI
+	:rtype: str containing the input without trailing newline character
 	:Example:
 		>>> get_text_line_input("PROMPT>", "getinfo")
 		PROMPT> Input!
@@ -1167,9 +1170,9 @@ def get_int_input(prompt, title):
 	.. 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 prompt: String to prompt with.
-	:param str title: Title of the window when executed in the UI.
-	:rtype: integer value input by the user.
+	:param str prompt: String to prompt with
+	:param str title: Title of the window when executed in the UI
+	:rtype: integer value input by the user
 	:Example:
 		>>> get_int_input("PROMPT>", "getinfo")
 		PROMPT> 10