summaryrefslogtreecommitdiff
path: root/python/binaryview.py
diff options
context:
space:
mode:
authorBrian Potchik <brian@vector35.com>2020-06-03 12:57:05 -0400
committerBrian Potchik <brian@vector35.com>2020-06-03 12:57:05 -0400
commit5aafda51cd308e66e42b40ac9ccc5ae9ad09b636 (patch)
tree8288762a395ef081c89f4450b422a4d4edee0e7c /python/binaryview.py
parent77663727de03c94ffafc6b62448763db2d77b488 (diff)
Update rebase documentation and fix return value.
Diffstat (limited to 'python/binaryview.py')
-rw-r--r--python/binaryview.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index bc4c2bbe..44d34ba2 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -5017,18 +5017,18 @@ class BinaryView(object):
def rebase(self, address, progress_func = None):
"""
- ``rebase`` rebase the existing BinaryView into a new BinaryView at the specified virtual address
+ ``rebase`` rebase the existing :py:class:`BinaryView` into a new :py:class:`BinaryView` at the specified virtual address
.. note:: This method should not be called from the UI and is intended for headless operation only.
- :param int address: virtual address of the start of the binary view
- :return: the new BinaryView object or None on failure
- :rtype: BinaryView or None
+ :param int address: virtual address of the start of the :py:class:`BinaryView`
+ :return: the new :py:class:`BinaryView` object or ``None`` on failure
+ :rtype: :py:class:`BinaryView` or ``None``
"""
result = False
if core.BNIsUIEnabled():
log.log_warn("The BinaryView.rebase API is for headless operation only.")
- return False
+ return None
if progress_func is None:
result = core.BNRebase(self.handle, address)
else: