From 4942700ca3387b64cc6443a80bac60b470588bb9 Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Mon, 17 Oct 2022 06:23:08 -0400 Subject: documentation overhaul --- python/__init__.py | 6 +++--- python/examples/triage/README.md | 2 +- python/interaction.py | 8 ++++++-- 3 files changed, 10 insertions(+), 6 deletions(-) (limited to 'python') diff --git a/python/__init__.py b/python/__init__.py index 2d36c7be..6798ebe1 100644 --- a/python/__init__.py +++ b/python/__init__.py @@ -178,7 +178,7 @@ def disable_default_log() -> None: def bundled_plugin_path() -> Optional[str]: """ - ``bundled_plugin_path`` returns a string containing the current plugin path inside the `install path `_ + ``bundled_plugin_path`` returns a string containing the current plugin path inside the `install path `_ :return: current bundled plugin path :rtype: str, or None on failure @@ -188,7 +188,7 @@ def bundled_plugin_path() -> Optional[str]: def user_plugin_path() -> Optional[str]: """ - ``user_plugin_path`` returns a string containing the current plugin path inside the `user directory `_ + ``user_plugin_path`` returns a string containing the current plugin path inside the `user directory `_ :return: current user plugin path :rtype: str, or None on failure @@ -198,7 +198,7 @@ def user_plugin_path() -> Optional[str]: def user_directory() -> Optional[str]: """ - ``user_directory`` returns a string containing the path to the `user directory `_ + ``user_directory`` returns a string containing the path to the `user directory `_ :return: current user path :rtype: str, or None on failure diff --git a/python/examples/triage/README.md b/python/examples/triage/README.md index d578bee2..99754481 100644 --- a/python/examples/triage/README.md +++ b/python/examples/triage/README.md @@ -13,7 +13,7 @@ In particular, the Triage plugin: ## Installation -This plugin is included by default if you are running the appropriate version of Binary Ninja (you may need to switch to the development channel in your [preferences](http://docs.binary.ninja/getting-started.html#preferencesupdates). To enable, simply copy from your [install path](http://docs.binary.ninja/getting-started.html#binary-path) to your [user](http://docs.binary.ninja/getting-started.html#user-folder)/plugins folder. +This plugin is included by default if you are running the appropriate version of Binary Ninja (you may need to switch to the development channel in your [preferences](http://docs.binary.ninja/guide/#preferencesupdates). To enable, simply copy from your [install path](http://docs.binary.ninja/guide/#binary-path) to your [user](http://docs.binary.ninja/guide/#user-folder)/plugins folder. ## Minimum Version diff --git a/python/interaction.py b/python/interaction.py index 9fb5d9c7..a82ad46e 100644 --- a/python/interaction.py +++ b/python/interaction.py @@ -194,12 +194,16 @@ class IntegerField: class AddressField: """ - ``AddressField`` prompts the user for an address. By passing the optional view and current_address parameters + ``AddressField`` prompts the user for an address. By passing the optional view and current_address parameters \ offsets can be used instead of just an address. The result is stored as in int in self.result. .. note:: This API currently functions differently on the command-line, as the view and current_address are \ disregarded. Additionally where as in the UI the result defaults to hexadecimal on the command-line 0x must be \ specified. + + :attr str prompt: prompt to be presented to the user + :attr BinaryView view: BinaryView for the address + :attr int current_address: current address to use as a base for relative calculations """ def __init__(self, prompt, view=None, current_address=0, default=None): self._prompt = prompt @@ -260,7 +264,7 @@ class AddressField: class ChoiceField: """ - ``ChoiceField`` prompts the user to choose from the list of strings provided in ``choices``. Result is stored + ``ChoiceField`` prompts the user to choose from the list of strings provided in ``choices``. Result is stored \ in self.result as an index in to the choices array. :attr str prompt: prompt to be presented to the user -- cgit v1.3.1