diff options
| -rw-r--r-- | python/binaryview.py | 13 | ||||
| -rw-r--r-- | python/bncompleter.py | 2 | ||||
| -rw-r--r-- | python/interaction.py | 4 | ||||
| -rw-r--r-- | python/pluginmanager.py | 2 |
4 files changed, 11 insertions, 10 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index b45b89ba..7ff4d4cf 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -4832,7 +4832,7 @@ class BinaryView(object): """ ``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. + ``binaryninja://?expr=_start`` Where ``expr=`` specifies an expression parsable by the :py:meth:`parse_expression` API. 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. @@ -4850,7 +4850,7 @@ class BinaryView(object): """ ``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. + ``binaryninja://?expr=_start`` Where ``expr=`` specifies an expression parsable by the :py:meth:`parse_expression` API. 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. @@ -5112,11 +5112,11 @@ class BinaryView(object): - Symbols are everything in ``bv.symbols``, unnamed DataVariables (i.e. ``data_00005000``), unnamed functions (i.e. ``sub_00005000``), or section names (i.e. ``.text``) - Numbers are defaulted to hexadecimal thus `_printf + 10` is equivalent to `printf + 0x10` If decimal numbers required use the decimal prefix. - Since numbers and symbols can be ambiguous its recommended that you prefix your numbers with the following: - + - ``0x`` - Hexadecimal - ``0n`` - Decimal - ``0`` - Octal - + - In the case of an ambiguous number/symbol (one with no prefix) for instance ``12345`` we will first attempt to look up the string as a symbol, if a symbol is found its address is used, otherwise we attempt to convert it to a hexadecimal number. @@ -5128,7 +5128,7 @@ class BinaryView(object): - ``[<expression>].w`` - read the word (2 bytes) at ``<expression>`` - ``[<expression>].d`` - read the dword (4 bytes) at ``<expression>`` - ``[<expression>].q`` - read the quadword (8 bytes) at ``<expression>`` - + - The ``$here`` keyword can be used in calculations and is defined as the ``here`` parameter - The ``$start``/``$end`` keyword represents the address of the first/last bytes in the file respectively @@ -5146,8 +5146,7 @@ class BinaryView(object): def eval(self, expression, here=0): """ - Evaluates an string expression to an integer value. This is a more concise alias for the `parse_expression` API - See `parse_expression` for details on usage. + Evaluates an string expression to an integer value. This is a more concise alias for the :py:meth:`parse_expression` API """ return self.parse_expression(expression, here) diff --git a/python/bncompleter.py b/python/bncompleter.py index 74d18631..9cb7d14f 100644 --- a/python/bncompleter.py +++ b/python/bncompleter.py @@ -6,7 +6,9 @@ https://github.com/python/cpython/blob/master/LICENSE The only changes made were to modify the regular expression in attr_matches and all code that relied on GNU readline (the later more for readability as it wasn't required). + -------------- + Word completion for GNU readline. The completer completes keywords, built-ins and globals in a selectable diff --git a/python/interaction.py b/python/interaction.py index 8e141374..9d52727a 100644 --- a/python/interaction.py +++ b/python/interaction.py @@ -1229,9 +1229,9 @@ def get_form_input(fields, title): - DirectoryNameField - Prompt for directory name This API is flexible and works both in the UI via a pop-up dialog and on the command-line. Note that more complicated APIs should consider usin the included pyside2 functionality in the `binaryninjaui` module. - :param fields: A list containing of the above specified classes, strings or None + :param fields: A list containing these classes, strings or None :type fields: list(str) or list(None) or list(LabelField) or list(SeparatorField) or list(TextLineField) or list(MultilineTextField) or list(IntegerField) or list(AddressField) or list(ChoiceField) or list(OpenFileNameField) or list(SaveFileNameField) or list(DirectoryNameField) - :param str title: The title of the pop-up dialog. + :param str title: The title of the pop-up dialog :rtype: None :Example: diff --git a/python/pluginmanager.py b/python/pluginmanager.py index 73fe0db6..fc3ac533 100644 --- a/python/pluginmanager.py +++ b/python/pluginmanager.py @@ -32,7 +32,7 @@ from binaryninja import range class RepoPlugin(object): """ - ``RepoPlugin` is mostly read-only, however you can install/uninstall enable/disable plugins. RepoPlugins are + ``RepoPlugin`` is mostly read-only, however you can install/uninstall enable/disable plugins. RepoPlugins are created by parsing the plugins.json in a plugin repository. """ def __init__(self, handle): |