summaryrefslogtreecommitdiff
path: root/python/filemetadata.py
diff options
context:
space:
mode:
authorGalen Williamson <galen@vector35.com>2024-04-19 17:11:04 -0400
committerGalen Williamson <galen@vector35.com>2024-04-19 17:11:04 -0400
commitc788961c5a7ff667d0b6237711f7747cac5be610 (patch)
tree2723627873dfbb033b9bb4fbe0ba3d8325d57f8d /python/filemetadata.py
parentcff2f4df2ad48f6e386e7eeed862dfca6659ab6d (diff)
docstring hygiene maintenance in python API
Diffstat (limited to 'python/filemetadata.py')
-rw-r--r--python/filemetadata.py9
1 files changed, 3 insertions, 6 deletions
diff --git a/python/filemetadata.py b/python/filemetadata.py
index a5dda467..e0222fd2 100644
--- a/python/filemetadata.py
+++ b/python/filemetadata.py
@@ -120,17 +120,14 @@ class FileMetadata:
"""
``class FileMetadata`` represents the file being analyzed by Binary Ninja. It is responsible for opening,
closing, creating the database (.bndb) files, and is used to keep track of undoable actions.
+
+ :param str filename: The string path to the file to be opened. Defaults to None.
+ :param handle: A handle to the underlying C FileMetadata object. Defaults to None. (Internal use only.)
"""
_associated_data = {}
def __init__(self, filename: Optional[str] = None, handle: Optional[core.BNFileMetadataHandle] = None):
- """
- Instantiates a new FileMetadata class.
-
- :param str filename: The string path to the file to be opened. Defaults to None.
- :param handle: A handle to the underlying C FileMetadata object. Defaults to None.
- """
if handle is not None:
_type = core.BNFileMetadataHandle
_handle = ctypes.cast(handle, _type)