Update documentation for Python Frame.older and Frame.newer

I noticed that Frame.older and Frame.newer don't document that they
return None at the ends of the stack.  This patch updates the
documentation, and also fixes a somewhat related typo in a comment
that I noticed while digging into this.

Approved-By: Eli Zaretskii <eliz@gnu.org>
This commit is contained in:
Tom Tromey
2023-05-19 09:40:35 -06:00
parent 05d31a0b3f
commit 3f33695b64
2 changed files with 5 additions and 3 deletions

View File

@ -5367,11 +5367,13 @@ Return the symbol for the function corresponding to this frame.
@end defun
@defun Frame.older ()
Return the frame that called this frame.
Return the frame that called this frame. If this is the oldest frame,
return @code{None}.
@end defun
@defun Frame.newer ()
Return the frame called by this frame.
Return the frame called by this frame. If this is the newest frame,
return @code{None}.
@end defun
@defun Frame.find_sal ()

View File

@ -2601,7 +2601,7 @@ inside_entry_func (frame_info_ptr this_frame)
}
/* Return a structure containing various interesting information about
the frame that called THIS_FRAME. Returns NULL if there is entier
the frame that called THIS_FRAME. Returns NULL if there is either
no such frame or the frame fails any of a set of target-independent
condition that should terminate the frame chain (e.g., as unwinding
past main()).