]> granicus.if.org Git - python/commitdiff
SF bug [#471111] inspect.getframeinfo() needs docs.
authorTim Peters <tim.peters@gmail.com>
Tue, 16 Oct 2001 23:01:06 +0000 (23:01 +0000)
committerTim Peters <tim.peters@gmail.com>
Tue, 16 Oct 2001 23:01:06 +0000 (23:01 +0000)
TeX-ified its docstring.

Doc/lib/libinspect.tex

index 24a181a7a39710f6405f3f2879de65fedc70d22e..b2813215278c699b24764b1ee33386c0d5f75ea1 100644 (file)
@@ -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.