summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Peters <tim.peters@gmail.com>2001-10-16 23:01:06 (GMT)
committerTim Peters <tim.peters@gmail.com>2001-10-16 23:01:06 (GMT)
commit61acf067ac7820d5e5a02c17d3d55f7f19a8e52e (patch)
tree970617e3b9c80b411318bd10ea22b213c0188fb9
parent49900000772ebd88e4b725a6b6227fd1cfcb6e3d (diff)
downloadcpython-61acf067ac7820d5e5a02c17d3d55f7f19a8e52e.zip
cpython-61acf067ac7820d5e5a02c17d3d55f7f19a8e52e.tar.gz
cpython-61acf067ac7820d5e5a02c17d3d55f7f19a8e52e.tar.bz2
SF bug [#471111] inspect.getframeinfo() needs docs.
TeX-ified its docstring.
-rw-r--r--Doc/lib/libinspect.tex6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/lib/libinspect.tex b/Doc/lib/libinspect.tex
index 24a181a..b281321 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.