summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2024-08-04 22:20:42 -0400
committerJordan Wiens <jordan@psifertex.com>2024-08-04 22:20:42 -0400
commit942d1cd1c0517e7a73a0a6f3d0102b25b967e40e (patch)
treec82f4f80af1561999fef503d4c919174b0ea1758 /python
parent8b3c5bc8ea70b837dd7fff17e79a60c3612169d9 (diff)
spellcheck pass on pydocs
Diffstat (limited to 'python')
-rw-r--r--python/architecture.py2
-rw-r--r--python/binaryview.py12
-rw-r--r--python/component.py4
-rw-r--r--python/function.py6
-rw-r--r--python/plugin.py4
-rw-r--r--python/pluginmanager.py4
-rw-r--r--python/typearchive.py10
-rw-r--r--python/variable.py2
-rw-r--r--python/workflow.py8
9 files changed, 26 insertions, 26 deletions
diff --git a/python/architecture.py b/python/architecture.py
index d07d718f..ec65b92e 100644
--- a/python/architecture.py
+++ b/python/architecture.py
@@ -193,7 +193,7 @@ class Architecture(metaclass=_ArchitectureMetaClass):
>>> from binaryninja import *
>>> arch = Architecture['x86']
- .. note:: The `max_instr_length` property of an architecture is not necessarily representative of the maximum instruction size of the associated CPU architecture. Rather, it represents the maximum size of a potential instruction that the architecture plugin can handle. So for example, the value for x86 is 16 despite the lagest valid instruction being only 15 bytes long, and the value for mips32 is currently 8 because multiple instrutions are decoded looking for delay slots so they can be reordered.
+ .. note:: The `max_instr_length` property of an architecture is not necessarily representative of the maximum instruction size of the associated CPU architecture. Rather, it represents the maximum size of a potential instruction that the architecture plugin can handle. So for example, the value for x86 is 16 despite the largest valid instruction being only 15 bytes long, and the value for mips32 is currently 8 because multiple instructions are decoded looking for delay slots so they can be reordered.
"""
name = None
diff --git a/python/binaryview.py b/python/binaryview.py
index 903c988f..cb067db6 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -2995,7 +2995,7 @@ class BinaryView:
@property
def entry_functions(self) -> FunctionList:
"""A List of entry functions (read-only)
- This list contains vanilla entry function, and functions like init_array, fini_arry, and TLS callbacks etc.
+ This list contains vanilla entry function, and functions like init_array, fini_array, and TLS callbacks etc.
User-added entry functions(via `add_entry_point`) are also included.
We see `entry_functions` as good starting points for analysis, these functions normally don't have internal references.
@@ -4133,7 +4133,7 @@ class BinaryView:
``navigate`` navigates the UI to the specified virtual address in the specified View
The View name is created by combining a View type (e.g. "Graph") with a BinaryView type (e.g. "Mach-O"),
- seperated by a colon, resulting in something like "Graph:Mach-O".
+ separated by a colon, resulting in something like "Graph:Mach-O".
:param str view_name: view name
:param int offset: address to navigate to
@@ -6665,9 +6665,9 @@ class BinaryView:
def get_component(self, guid: str) -> Optional[component.Component]:
"""
- Lookup a Component by its Guid
+ Lookup a Component by its GUID
- :param guid: Guid of the component to look up
+ :param guid: GUID of the component to look up
:return: The Component with that Guid
"""
bn_component = core.BNGetComponentByGuid(self.handle, guid)
@@ -7959,7 +7959,7 @@ to a the type "tagRECT" found in the typelibrary "winX64common"
) -> None:
"""
``record_imported_object_library`` should be called by custom py:py:class:`BinaryView` implementations
- when they have successfully imported an object from a type library (eg a symbol's type).
+ when they have successfully imported an object from a type library (e.g. a symbol's type).
Values recorded with this function will then be queryable via ``lookup_imported_object_library``.
:param lib: Type Library containing the imported type
@@ -9391,7 +9391,7 @@ to a the type "tagRECT" found in the typelibrary "winX64common"
it to a hexadecimal number.
- The following operations are valid: ``+, -, \*, /, %, (), &, \|, ^, ~, ==, !=, >, <, >=, <=``
- - Comparision operators return 1 if the condition is true, 0 otherwise.
+ - Comparison operators return 1 if the condition is true, 0 otherwise.
- In addition to the above operators there are dereference operators similar to BNIL style IL:
diff --git a/python/component.py b/python/component.py
index 3f56fe71..95215fed 100644
--- a/python/component.py
+++ b/python/component.py
@@ -293,7 +293,7 @@ class Component:
"""
Get data variables referenced by this component
- :param recursive: Optional; Get all DataVariables referenced by this component and subcomponents.
+ :param recursive: Optional; Get all DataVariables referenced by this component and sub-components.
:return: List of DataVariables
"""
data_vars = []
@@ -315,7 +315,7 @@ class Component:
"""
Get Types referenced by this component
- :param recursive: Optional; Get all Types referenced by this component and subcomponents.
+ :param recursive: Optional; Get all Types referenced by this component and sub-components.
:return: List of Types
"""
_types = []
diff --git a/python/function.py b/python/function.py
index 0b8abc1f..5ed61603 100644
--- a/python/function.py
+++ b/python/function.py
@@ -3127,7 +3127,7 @@ class Function:
self, target: 'variable.Variable', sources: Union[List['variable.Variable'], 'variable.Variable']
) -> None:
"""
- ``merge_vars`` merges one or more varibles in ``sources`` into the ``target`` variable. All
+ ``merge_vars`` merges one or more variables in ``sources`` into the ``target`` variable. All
variable accesses to the variables in ``sources`` will be rewritten to use ``target``.
:param Variable target: target variable
@@ -3163,7 +3163,7 @@ class Function:
def split_var(self, var: 'variable.Variable') -> None:
"""
- ``split_var`` splits a varible at the definition site. The given ``var`` must be the
+ ``split_var`` splits a variable at the definition site. The given ``var`` must be the
variable unique to the definition and should be obtained by using
``MediumLevelILInstruction.get_split_var_for_definition`` at the definition site.
@@ -3182,7 +3182,7 @@ class Function:
def unsplit_var(self, var: 'variable.Variable') -> None:
"""
- ``unsplit_var`` undoes varible splitting performed with ``split_var``. The given ``var``
+ ``unsplit_var`` undoes variable splitting performed with ``split_var``. The given ``var``
must be the variable unique to the definition and should be obtained by using
``MediumLevelILInstruction.get_split_var_for_definition`` at the definition site.
diff --git a/python/plugin.py b/python/plugin.py
index 5a92215b..1536b3bc 100644
--- a/python/plugin.py
+++ b/python/plugin.py
@@ -980,7 +980,7 @@ class BackgroundTask(metaclass=_BackgroundTaskMetaclass):
available via the :py:class:`.BackgroundTaskThread` class.
:param initial_progress_text: text description of the task to display in the status bar in the UI, defaults to `""`
- :param can_cancel: whether to enable cancelation of the task, defaults to `False`
+ :param can_cancel: whether to enable cancellation of the task, defaults to `False`
"""
def __init__(self, initial_progress_text="", can_cancel=False, handle=None):
if handle is None:
@@ -1041,7 +1041,7 @@ class BackgroundTaskThread(BackgroundTask):
See the :py:class:`.BackgroundTask` for additional information.
:param initial_progress_text: text description of the task to display in the status bar in the UI, defaults to `""`
- :param can_cancel: whether to enable cancelation of the task, defaults to `False`
+ :param can_cancel: whether to enable cancellation of the task, defaults to `False`
"""
def __init__(self, initial_progress_text: str = "", can_cancel: bool = False):
class _Thread(threading.Thread):
diff --git a/python/pluginmanager.py b/python/pluginmanager.py
index 94232e2f..4627ede5 100644
--- a/python/pluginmanager.py
+++ b/python/pluginmanager.py
@@ -106,8 +106,8 @@ class RepoPlugin:
"""
Enable this plugin, optionally trying to force it. \
Force loading a plugin with ignore platform and api constraints. \
- (e.g. The plugin author says the plugin will only work on Linux-python3 but you'd like to \
- attempt to load it on Macos-python2)
+ (e.g. The plugin author says the plugin will only work on Linux but you'd like to \
+ attempt to load it on macOS)
"""
return core.BNPluginEnable(self.handle, force)
diff --git a/python/typearchive.py b/python/typearchive.py
index 60897d94..441e40da 100644
--- a/python/typearchive.py
+++ b/python/typearchive.py
@@ -125,7 +125,7 @@ class TypeArchive:
@property
def id(self) -> Optional[str]:
"""
- Get the guid for a Type Archive
+ Get the GUID for a Type Archive
:return: Guid string
"""
@@ -222,7 +222,7 @@ class TypeArchive:
def add_type(self, name: '_types.QualifiedNameType', type: '_types.Type') -> None:
"""
- Add named types to the type archive. Type must have all dependant named types added
+ Add named types to the type archive. Type must have all dependent named types added
prior to being added, or this function will fail.
If the type already exists, it will be overwritten.
@@ -233,9 +233,9 @@ class TypeArchive:
def add_types(self, new_types: List[Tuple['_types.QualifiedNameType', '_types.Type']]) -> None:
"""
- Add named types to the type archive. Types must have all dependant named
- types prior to being added, or included in the list, or this function will fail.
- Types already existing with any added names will be overwritten.
+ Add named types to the type archive. Types must have all dependent named
+ types added prior to the parent types being added (or included in the list) or this
+ function will fail. Types already existing with any added names will be overwritten.
:param new_types: Names and definitions of new types
"""
diff --git a/python/variable.py b/python/variable.py
index 3ca4bb1c..b9fff22d 100644
--- a/python/variable.py
+++ b/python/variable.py
@@ -604,7 +604,7 @@ class PossibleValueSet:
def lookup_table_value(lookup_table, mapping) -> 'PossibleValueSet':
"""
Create a PossibleValueSet object for a value which is a member of a
- lookuptable.
+ lookup table.
:param list(LookupTableEntry) lookup_table: List of table entries
:param dict of (int, int) mapping: Mapping used for resolution
diff --git a/python/workflow.py b/python/workflow.py
index 0ed013ab..f5c34238 100644
--- a/python/workflow.py
+++ b/python/workflow.py
@@ -72,7 +72,7 @@ class AnalysisContext:
@property
def llil(self) -> lowlevelil.LowLevelILFunction:
"""
- LowLevelILFunction used to represent Low Level IL (writeable)
+ LowLevelILFunction used to represent Low Level IL (writable)
"""
result = core.BNAnalysisContextGetLowLevelILFunction(self.handle)
if not result:
@@ -86,7 +86,7 @@ class AnalysisContext:
@property
def mlil(self) -> mediumlevelil.MediumLevelILFunction:
"""
- MediumLevelILFunction used to represent Medium Level IL (writeable)
+ MediumLevelILFunction used to represent Medium Level IL (writable)
"""
result = core.BNAnalysisContextGetMediumLevelILFunction(self.handle)
if not result:
@@ -100,7 +100,7 @@ class AnalysisContext:
@property
def hlil(self) -> highlevelil.HighLevelILFunction:
"""
- HighLevelILFunction used to represent High Level IL (writeable)
+ HighLevelILFunction used to represent High Level IL (writable)
"""
result = core.BNAnalysisContextGetHighLevelILFunction(self.handle)
if not result:
@@ -114,7 +114,7 @@ class AnalysisContext:
@property
def basic_blocks(self) -> '_function.BasicBlockList':
"""
- function.BasicBlockList of BasicBlocks in the current function (writeable)
+ function.BasicBlockList of BasicBlocks in the current function (writable)
"""
return _function.BasicBlockList(self.function)