From 3cf8d8f04d6dfa916513d226eecb78108ccc9637 Mon Sep 17 00:00:00 2001 From: Alexander Taylor Date: Fri, 15 Nov 2024 11:57:24 -0500 Subject: Add warnings about silent failures in function APIs. Attempts to partially address #6019. --- python/function.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'python') 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 -- cgit v1.3.1