Fix execute_frame_filters doc string
authorTom Tromey <tromey@adacore.com>
Wed, 14 Jun 2023 12:27:49 +0000 (06:27 -0600)
committerTom Tromey <tromey@adacore.com>
Mon, 10 Jul 2023 19:17:30 +0000 (13:17 -0600)
When reading the doc string for execute_frame_filters, I wasn't sure
if the ranges were inclusive or exclusive.  This patch updates the doc
string to reflect my findings, and also fixes an existing typo.

gdb/python/lib/gdb/frames.py

index 0287a9bf3d3d2ce78fec81ab04c400fa35f8c735..4b2141ed722e1ec7d2be92fddecacdb30845b631 100644 (file)
@@ -165,18 +165,20 @@ def execute_frame_filters(frame, frame_low, frame_high):
     Arguments:
         frame: The initial frame.
 
-        frame_low: The low range of the slice.  If this is a negative
-        integer then it indicates a backward slice (ie bt -4) which
-        counts backward from the last frame in the backtrace.
+        frame_low: The low range of the slice, counting from 0.  If
+        this is a negative integer then it indicates a backward slice
+        (ie bt -4) which counts backward from the last frame in the
+        backtrace.
 
-        frame_high: The high range of the slice.  If this is -1 then
-        it indicates all frames until the end of the stack from
-        frame_low.
+        frame_high: The high range of the slice, inclusive.  If this
+        is -1 then it indicates all frames until the end of the stack
+        from frame_low.
 
     Returns:
         frame_iterator: The sliced iterator after all frame
-        filters have had a change to execute, or None if no frame
+        filters have had a chance to execute, or None if no frame
         filters are registered.
+
     """
 
     # Get a sorted list of frame filters.