summaryrefslogtreecommitdiff
path: root/python/function.py
diff options
context:
space:
mode:
authorAlexander Taylor <alex@vector35.com>2024-11-15 11:57:24 -0500
committerAlexander Taylor <alex@vector35.com>2024-11-15 11:57:24 -0500
commit3cf8d8f04d6dfa916513d226eecb78108ccc9637 (patch)
treeb4e2dde1135fef284872aabb01cad756b24d7c16 /python/function.py
parentd729259be975801c3ee2ee6b687756d036277893 (diff)
Add warnings about silent failures in function APIs.
Attempts to partially address #6019.
Diffstat (limited to 'python/function.py')
-rw-r--r--python/function.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/python/function.py b/python/function.py
index 8b6239f3..6e7eef73 100644
--- a/python/function.py
+++ b/python/function.py
@@ -833,7 +833,9 @@ class Function:
>>> current_function.add_tag("Important", "I think this is the main function")
>>> current_function.add_tag("Crashes", "Nullpointer dereference", here)
- >>>
+
+ Warning: For performance reasons, this function does not ensure the address you
+ have supplied is within the function's bounds.
"""
tag_type = self.view.get_tag_type(tag_type)
if tag_type is None:
@@ -2560,6 +2562,9 @@ class Function:
>>> current_function.set_user_instr_highlight(here, HighlightStandardColor.BlueHighlightColor)
>>> current_function.set_user_instr_highlight(here, highlight.HighlightColor(red=0xff, blue=0xff, green=0))
+
+ Warning: For performance reasons, this function does not ensure the address you have supplied is within the
+ function's bounds.
"""
if arch is None:
arch = self.arch