summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2023-06-05 20:41:19 -0400
committerJordan Wiens <jordan@psifertex.com>2023-06-05 20:41:19 -0400
commit56531213400439984da767ef9bc64ea4b2a091a0 (patch)
tree0ac220b21233a1c30bfa79daab911b8b1f58b5da
parentbdd240a8a07dd154725aef55c74202828e7384ae (diff)
cleanup pydoc warnings
-rw-r--r--python/binaryview.py17
-rw-r--r--python/enterprise.py2
-rw-r--r--python/interaction.py2
3 files changed, 11 insertions, 10 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index 6cb66bdb..41fdf644 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -80,6 +80,7 @@ StringOrType = Union[str, '_types.Type', '_types.TypeBuilder']
class RelocationWriteException(Exception):
+ """ Exception raised when a relocation fails to apply """
pass
@@ -2706,10 +2707,10 @@ class BinaryView:
"""
List of all types, sorted such that types are after all types on which they depend (read-only)
- Order is guaranteed for any collection of types with no cycles. If you have cycles
+ Order is guaranteed for any collection of types with no cycles. If you have cycles \
in type dependencies, order for types in a cycle is not guaranteed.
- .. note:: Dependency order is based on named type references for all non-structure types, i.e.
+ .. note:: Dependency order is based on named type references for all non-structure types, i.e. \
``struct Foo m_foo`` will induce a dependency, whereas ``struct Foo* m_pFoo`` will not.
:return: sorted types as defined above
@@ -4309,8 +4310,8 @@ class BinaryView:
reference, see :py:func:`add_user_data_ref`.
.. warning:: If you're looking at this API, please double check that you don't mean to use :py:func:`get_code_refs` instead. \
- `get_code_refs` returns references from code to the specified address while this API returns references from data \
- (pointers in global variables for example). \
+ `get_code_refs` returns references from code to the specified address while this API returns references from data \
+ (pointers in global variables for example).
:param int addr: virtual address to query for references
:param int length: optional length of query
@@ -7097,14 +7098,14 @@ class BinaryView:
def import_library_object(self, name: str, lib: Optional[typelibrary.TypeLibrary] = None) -> Optional['_types.Type']:
"""
- ``import_library_object`` recursively imports an object from the specified type library, or, if
- no library was explicitly provided, the first type library associated with the current :py:class:`BinaryView`
+ ``import_library_object`` recursively imports an object from the specified type library, or, if \
+ no library was explicitly provided, the first type library associated with the current :py:class:`BinaryView` \
that provides the name requested.
- This may have the impact of loading other type libraries as dependencies on other type libraries are lazily resolved
+ This may have the impact of loading other type libraries as dependencies on other type libraries are lazily resolved \
when references to types provided by them are first encountered.
- .. note:: If you are implementing a custom BinaryView and use this method to import object types,
+ .. note:: If you are implementing a custom BinaryView and use this method to import object types, \
you should then call ``record_imported_object`` with the details of where the object is located.
:param QualifiedName name:
diff --git a/python/enterprise.py b/python/enterprise.py
index a6f03836..915f6c30 100644
--- a/python/enterprise.py
+++ b/python/enterprise.py
@@ -254,7 +254,7 @@ def release_license():
.. note:: You must authenticate with the Enterprise Server before calling this.
- .. note:: This will deactivate the Binary Ninja Enterprise client. You must call :func:`acquire_license`
+ .. note:: This will deactivate the Binary Ninja Enterprise client. You must call :func:`acquire_license` \
again to continue using Binary Ninja Enterprise in the current process.
"""
if not core.BNReleaseEnterpriseServerLicense():
diff --git a/python/interaction.py b/python/interaction.py
index 4b296ab3..b5b4bee4 100644
--- a/python/interaction.py
+++ b/python/interaction.py
@@ -1216,7 +1216,7 @@ def get_choice_input(prompt, title, choices):
def get_open_filename_input(prompt: str, ext: str = "") -> Optional[str]:
- r"""
+ """
``get_open_filename_input`` prompts the user for a file name to open
.. note:: This API functions differently on the command-line vs the UI. In the UI a pop-up is used. On the command-line \