From: Tim Peters <tim.peters@gmail.com>
Date: Tue, 16 Oct 2001 23:01:06 +0000 (+0000)
Subject: SF bug [#471111] inspect.getframeinfo() needs docs.
X-Git-Tag: v2.2.1c1~1238
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=61acf067ac7820d5e5a02c17d3d55f7f19a8e52e;p=thirdparty%2FPython%2Fcpython.git

SF bug [#471111] inspect.getframeinfo() needs docs.
TeX-ified its docstring.
---

diff --git a/Doc/lib/libinspect.tex b/Doc/lib/libinspect.tex
index 24a181a7a397..b2813215278c 100644
--- a/Doc/lib/libinspect.tex
+++ b/Doc/lib/libinspect.tex
@@ -282,6 +282,12 @@ created, it is important to ensure they are explicitly broken to avoid
 the delayed destruction of objects and increased memory consumption
 which occurs.
 
+\begin{funcdesc}{getframeinfo}{frame\optional{, context}}
+  Get information about a frame or traceback object.  A 5-tuple
+  is returned, the last five elements of the frame's frame record.
+  The optional second argument specifies the number of lines of context
+  to return, which are centered around the current line.
+
 \begin{funcdesc}{getouterframes}{frame\optional{, context}}
   Get a list of frame records for a frame and all higher (calling)
   frames.