summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorGalen Williamson <galen@vector35.com>2024-04-19 17:53:50 -0400
committerGalen Williamson <galen@vector35.com>2024-04-19 17:53:50 -0400
commit0ce2e87dad1f2f5d1ff95f9d58a134caedb02956 (patch)
tree9d6408ecca903731f342298a9ea65c2dadb59557 /python
parentc788961c5a7ff667d0b6237711f7747cac5be610 (diff)
fixed class docstrings in enterprise.py and typearchive.py
Diffstat (limited to 'python')
-rw-r--r--python/enterprise.py7
-rw-r--r--python/typearchive.py9
2 files changed, 14 insertions, 2 deletions
diff --git a/python/enterprise.py b/python/enterprise.py
index 636b9023..e645ed5f 100644
--- a/python/enterprise.py
+++ b/python/enterprise.py
@@ -320,6 +320,11 @@ class LicenseCheckout:
"""
Helper class for scripts to make use of a license checkout in a scope.
+ :param duration: Duration between refreshes
+ :param _cache: Deprecated but left in for compatibility
+ :param release: If the license should be released at the end of scope. If `False`, you
+ can either manually release it later or it will expire after `duration`.
+
:Example:
>>> enterprise.connect()
>>> enterprise.authenticate_with_credentials("username", "password")
@@ -335,7 +340,7 @@ class LicenseCheckout:
:param duration: Duration between refreshes
:param _cache: Deprecated but left in for compatibility
- :param release: If the license should be released at the end of scope. If False, you
+ :param release: If the license should be released at the end of scope. If `False`, you
can either manually release it later or it will expire after `duration`.
"""
self.desired_duration = duration
diff --git a/python/typearchive.py b/python/typearchive.py
index 96e5378d..7b264056 100644
--- a/python/typearchive.py
+++ b/python/typearchive.py
@@ -39,13 +39,20 @@ class TypeArchive:
Type Archives are a collection of types which can be shared between different analysis
sessions and are backed by a database file on disk. Their types can be modified, and
a history of previous versions of types is stored in snapshots in the archive.
+
+
+ Internal-use constructor. API users will want to use :py:meth:`.TypeArchive.open`
+ or :py:meth:`.TypeArchive.create` instead to get an instance of a TypeArchive.
+
+ :param handle: Handle pointer (Internal use only.)
"""
def __init__(self, handle: core.BNTypeArchiveHandle):
"""
Internal-use constructor. API users will want to use `:py:func:TypeArchive.open`
or `:py:func:TypeArchive.create` instead to get an instance of a TypeArchive.
- :param handle:
+
+ :param handle: Handle pointer (Internal use only.)
"""
binaryninja._init_plugins()
self.handle: core.BNTypeArchiveHandle = core.handle_of_type(handle, core.BNTypeArchive)