From ebfbe25ef9b0ae5f5d6c6d53bd5faee7b9a77d59 Mon Sep 17 00:00:00 2001 From: Josh Ferrell Date: Wed, 16 Nov 2022 11:40:16 -0500 Subject: Small docstring improvements --- python/binaryview.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'python') diff --git a/python/binaryview.py b/python/binaryview.py index 5abcc026..d73c8ebc 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -7629,7 +7629,7 @@ class BinaryView: """ Returns a read-only dict of the address comments attached to this BinaryView - Note that these are different from function-level comments which are specific to each _function. + Note that these are different from function-level comments which are specific to each :py:Class:`Function`. For annotating code, it is recommended to use comments attached to functions rather than address comments attached to the BinaryView. On the other hand, BinaryView comments can be attached to data whereas function comments cannot. @@ -7650,7 +7650,7 @@ class BinaryView: def get_comment_at(self, addr: int) -> str: """ ``get_comment_at`` returns the address-based comment attached to the given address in this BinaryView - Note that address-based comments are different from function-level comments which are specific to each _function. + Note that address-based comments are different from function-level comments which are specific to each :py:Class:`Function`. For more information, see :func:`address_comments`. :param int addr: virtual address within the current BinaryView to apply the comment to :rtype: str @@ -7662,7 +7662,7 @@ class BinaryView: """ ``set_comment_at`` sets a comment for the BinaryView at the address specified - Note that these are different from function-level comments which are specific to each _function. \ + Note that these are different from function-level comments which are specific to each :py:Class:`Function`. \ For more information, see :func:`address_comments`. :param int addr: virtual address within the current BinaryView to apply the comment to -- cgit v1.3.1