diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2022-10-17 06:23:08 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2022-10-17 06:23:08 -0400 |
| commit | 4942700ca3387b64cc6443a80bac60b470588bb9 (patch) | |
| tree | 7ab0b29c72e9146734b3cb24d062dff148c2b8ec /python/interaction.py | |
| parent | fba5ef5a7cb2c0f76cf2531adddda9d3023c2357 (diff) | |
documentation overhaul
Diffstat (limited to 'python/interaction.py')
| -rw-r--r-- | python/interaction.py | 8 |
1 files changed, 6 insertions, 2 deletions
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 |