summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2021-04-09 23:21:53 -0400
committerJordan Wiens <jordan@psifertex.com>2021-04-10 10:56:28 -0400
commit02eb9130a43c2bf4e116200d8ec2213acd7ad978 (patch)
tree173b6df12f921a122ab3bf000f1402e3caefe26b /python
parenta39ee992ab54eddb4ce06c41e8d552e55bf4e0b2 (diff)
small doc update on open_view api
Diffstat (limited to 'python')
-rw-r--r--python/__init__.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/python/__init__.py b/python/__init__.py
index 5dce604b..1b199c9a 100644
--- a/python/__init__.py
+++ b/python/__init__.py
@@ -242,7 +242,7 @@ def get_memory_usage_info():
def open_view(*args, **kwargs):
"""
- `open_view` opens a BinaryView object.
+ `open_view` is a convenience wrapper for :py:class:`get_view_of_file_with_options` that opens a BinaryView object.
.. note:: If attempting to open a BNDB, the file MUST have the suffix .bndb, or else the file will not be loaded as a database.