diff options
| author | Galen Williamson <galen@vector35.com> | 2022-08-18 19:06:38 -0400 |
|---|---|---|
| committer | Galen Williamson <galen@vector35.com> | 2022-08-18 19:48:35 -0400 |
| commit | e2107c90ab2cfbf1c4910af976a906149ff13693 (patch) | |
| tree | 688231429e0f524d94ccf809a80caddcbd9609bf /python | |
| parent | 6b55b281854a64e963ae33b4d5dc92b500bfb1a8 (diff) | |
fix typos in various doc strings (a/an, repeated words) (skip-ci)
Diffstat (limited to 'python')
| -rw-r--r-- | python/binaryview.py | 30 | ||||
| -rw-r--r-- | python/function.py | 8 | ||||
| -rw-r--r-- | python/types.py | 4 |
3 files changed, 21 insertions, 21 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index afdb6f96..bae74982 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -1056,7 +1056,7 @@ class BinaryViewType(metaclass=_BinaryViewTypeMetaclass): """ `load` is a convenience wrapper for :py:class:`BinaryViewType.load_raw_view_with_options` that opens a BinaryView object. - :param Union[str, bytes, bytearray, 'databuffer.DataBuffer'] source: a file or byte stream for which load load into a virtual memory space + :param Union[str, bytes, bytearray, 'databuffer.DataBuffer'] source: a file or byte stream from which to load data into a virtual memory space :param bool update_analysis: whether or not to run :func:`update_analysis_and_wait` after opening a :py:class:`BinaryView`, defaults to ``True`` :param callback progress_func: optional function to be called with the current progress and total count :param dict options: a dictionary in the form {setting identifier string : object value} @@ -3018,7 +3018,7 @@ class BinaryView: def perform_is_valid_offset(self, addr: int) -> bool: """ - ``perform_is_valid_offset`` implements a check if an virtual address ``addr`` is valid. + ``perform_is_valid_offset`` implements a check if a virtual address ``addr`` is valid. .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide \ data without overriding this method. @@ -3034,7 +3034,7 @@ class BinaryView: def perform_is_offset_readable(self, offset: int) -> bool: """ - ``perform_is_offset_readable`` implements a check if an virtual address is readable. + ``perform_is_offset_readable`` implements a check if a virtual address is readable. .. note:: This method **may** be overridden by custom BinaryViews. Use :func:`add_auto_segment` to provide \ data without overriding this method. @@ -3473,7 +3473,7 @@ class BinaryView: def is_valid_offset(self, addr: int) -> bool: """ - ``is_valid_offset`` checks if an virtual address ``addr`` is valid . + ``is_valid_offset`` checks if a virtual address ``addr`` is valid . :param int addr: a virtual address to be checked :return: true if the virtual address is valid, false if the virtual address is invalid or error @@ -3483,7 +3483,7 @@ class BinaryView: def is_offset_readable(self, addr: int) -> bool: """ - ``is_offset_readable`` checks if an virtual address ``addr`` is valid for reading. + ``is_offset_readable`` checks if a virtual address ``addr`` is valid for reading. :param int addr: a virtual address to be checked :return: true if the virtual address is valid for reading, false if the virtual address is invalid or error @@ -3493,7 +3493,7 @@ class BinaryView: def is_offset_writable(self, addr: int) -> bool: """ - ``is_offset_writable`` checks if an virtual address ``addr`` is valid for writing. + ``is_offset_writable`` checks if a virtual address ``addr`` is valid for writing. :param int addr: a virtual address to be checked :return: true if the virtual address is valid for writing, false if the virtual address is invalid or error @@ -3503,7 +3503,7 @@ class BinaryView: def is_offset_executable(self, addr: int) -> bool: """ - ``is_offset_executable`` checks if an virtual address ``addr`` is valid for executing. + ``is_offset_executable`` checks if a virtual address ``addr`` is valid for executing. :param int addr: a virtual address to be checked :return: true if the virtual address is valid for executing, false if the virtual address is invalid or error @@ -3513,7 +3513,7 @@ class BinaryView: def is_offset_code_semantics(self, addr: int) -> bool: """ - ``is_offset_code_semantics`` checks if an virtual address ``addr`` is semantically valid for code. + ``is_offset_code_semantics`` checks if a virtual address ``addr`` is semantically valid for code. :param int addr: a virtual address to be checked :return: true if the virtual address is valid for code semantics, false if the virtual address is invalid or error @@ -3523,17 +3523,17 @@ class BinaryView: def is_offset_extern_semantics(self, addr: int) -> bool: """ - ``is_offset_extern_semantics`` checks if an virtual address ``addr`` is semantically valid for external references. + ``is_offset_extern_semantics`` checks if a virtual address ``addr`` is semantically valid for external references. :param int addr: a virtual address to be checked - :return: true if the virtual address is valid for for external references, false if the virtual address is invalid or error + :return: true if the virtual address is valid for external references, false if the virtual address is invalid or error :rtype: bool """ return core.BNIsOffsetExternSemantics(self.handle, addr) def is_offset_writable_semantics(self, addr: int) -> bool: """ - ``is_offset_writable_semantics`` checks if an virtual address ``addr`` is semantically writable. Some sections + ``is_offset_writable_semantics`` checks if a virtual address ``addr`` is semantically writable. Some sections may have writable permissions for linking purposes but can be treated as read-only for the purposes of analysis. @@ -5361,7 +5361,7 @@ class BinaryView: """ ``add_user_data_tag`` adds an already-created Tag object at a data address. Since this adds a user tag, it will be added to the current undo buffer. - If you want want to create the tag as well, consider using + If you want to create the tag as well, consider using :meth:`create_user_data_tag <binaryninja.binaryview.BinaryView.create_user_data_tag>` :param int addr: Address at which to add the tag @@ -5427,7 +5427,7 @@ class BinaryView: def add_auto_data_tag(self, addr: int, tag: 'Tag') -> None: """ ``add_auto_data_tag`` adds an already-created Tag object at a data address. - If you want want to create the tag as well, consider using + If you want to create the tag as well, consider using :meth:`create_auto_data_tag <binaryninja.binaryview.BinaryView.create_auto_data_tag>` :param int addr: Address at which to add the tag @@ -7103,7 +7103,7 @@ class BinaryView: :param callback match_callback: function that gets called when a match is found. The \ callback takes two parameters, i.e., the address of the match, and the \ LinearDisassemblyLine that contains the matching line. If this parameter is None, \ - this function becomes a generator and yields the the matching address and the \ + this function becomes a generator and yields the matching address and the \ matching LinearDisassemblyLine. This function can return a boolean value that \ decides whether the search should continue or stop :rtype bool: whether any (one or more) match is found for the search @@ -7646,7 +7646,7 @@ class BinaryView: def eval(self, expression: str, here: int = 0) -> int: """ - Evaluates an string expression to an integer value. This is a more concise alias for the :py:meth:`parse_expression` API + Evaluates a 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/function.py b/python/function.py index d2855234..06a9beb5 100644 --- a/python/function.py +++ b/python/function.py @@ -656,7 +656,7 @@ class Function: """ ``add_user_address_tag`` adds an already-created Tag object at a given address. Since this adds a user tag, it will be added to the current undo buffer. - If you want want to create the tag as well, consider using + If you want to create the tag as well, consider using :meth:`create_user_address_tag <function.Function.create_user_address_tag>` :param int addr: Address at which to add the tag @@ -721,7 +721,7 @@ class Function: ) -> None: """ ``add_auto_address_tag`` adds an already-created Tag object at a given address. - If you want want to create the tag as well, consider using + If you want to create the tag as well, consider using :meth:`create_auto_address_tag <function.Function.create_auto_address_tag>` :param int addr: Address at which to add the tag @@ -784,7 +784,7 @@ class Function: """ ``add_user_function_tag`` adds an already-created Tag object as a function tag. Since this adds a user tag, it will be added to the current undo buffer. - If you want want to create the tag as well, consider using + If you want to create the tag as well, consider using :meth:`create_user_function_tag <function.Function.create_user_function_tag>` :param Tag tag: Tag object to be added @@ -825,7 +825,7 @@ class Function: def add_auto_function_tag(self, tag: 'binaryview.Tag') -> None: """ ``add_auto_function_tag`` adds an already-created Tag object as a function tag. - If you want want to create the tag as well, consider using + If you want to create the tag as well, consider using :meth:`create_auto_function_tag <function.Function.create_auto_function_tag>` :param Tag tag: Tag object to be added :rtype: None diff --git a/python/types.py b/python/types.py index 2734f0a9..1aba0ae9 100644 --- a/python/types.py +++ b/python/types.py @@ -659,7 +659,7 @@ class TypeBuilder: stack_adjust: Optional[OffsetWithConfidenceType] = None ) -> 'FunctionBuilder': """ - ``function`` class method for creating an function Type. + ``function`` class method for creating a function Type. :param Type ret: return Type of the function :param params: list of parameter Types :type params: list(Type) @@ -2037,7 +2037,7 @@ class Type: stack_adjust: OffsetWithConfidence = OffsetWithConfidence(0) ) -> 'FunctionType': """ - ``function`` class method for creating an function Type. + ``function`` class method for creating a function Type. :param Type ret: return Type of the function :param params: list of parameter Types :type params: list(Type) |
