add pydoc for navigation APIs and get_address-for_data_offset

1 files changed, 15 insertions, 0 deletions

diff --git a/python/filemetadata.py b/python/filemetadata.py
index e8c72775..3f2e88ef 100644
--- a/python/filemetadata.py
+++ b/python/filemetadata.py
@@ -369,6 +369,21 @@ class FileMetadata(object):
 		core.BNRedo(self.handle)
 
 	def navigate(self, view, offset):
+		"""
+		``navigate`` navigates the UI to the specified virtual address
+
+		.. note:: Despite the confusing name, ``view`` in this context is not a BinaryView but rather a string describing the different UI Views.  Check :py:attr:`view` while in different views to see examples such as ``Linear:ELF``, ``Graph:PE``.
+
+		:param str view: virtual address to read from.
+		:param int offset: address to navigate to
+		:return: whether or not navigation succeeded
+		:rtype: bool
+		:Example:
+
+			>>> import random
+			>>> bv.navigate(bv.view, random.choice(bv.functions).start)
+			True
+		"""
 		return core.BNNavigate(self.handle, str(view), offset)
 
 	def create_database(self, filename, progress_func = None, settings = None):