From: masklinn <github.com@masklinn.net>
Date: Fri, 5 May 2017 08:15:12 +0000 (+0200)
Subject: bpo-29920: Document cgitb.text() and cgitb.html() functions (GH-849)
X-Git-Tag: v3.7.0a1~852
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=c07b3a15be5e0a68a73b4c532861ed8de6932bd2;p=python

bpo-29920: Document cgitb.text() and cgitb.html() functions (GH-849)
---

diff --git a/Doc/library/cgitb.rst b/Doc/library/cgitb.rst
index b65a6355fe..5f3a6476dd 100644
--- a/Doc/library/cgitb.rst
+++ b/Doc/library/cgitb.rst
@@ -54,6 +54,24 @@ analysis.
    value forces plain text output.  The default value is ``"html"``.
 
 
+.. function:: text(info, context=5)
+
+   This function handles the exception described by *info* (a 3-tuple containing
+   the result of :func:`sys.exc_info`), formatting its traceback as text and
+   returning the result as a string. The optional argument *context* is the
+   number of lines of context to display around the current line of source code
+   in the traceback; this defaults to ``5``.
+
+
+.. function:: html(info, context=5)
+
+   This function handles the exception described by *info* (a 3-tuple containing
+   the result of :func:`sys.exc_info`), formatting its traceback as HTML and
+   returning the result as a string. The optional argument *context* is the
+   number of lines of context to display around the current line of source code
+   in the traceback; this defaults to ``5``.
+
+
 .. function:: handler(info=None)
 
    This function handles an exception using the default settings (that is, show a