[Zope3-checkins] SVN: Zope3/trunk/src/zope/exceptions/interfaces.py Added documentation on __traceback_info__ and __traceback_supplement__

[Shane Hathaway]

Log message for revision 41470:
  Added documentation on __traceback_info__ and __traceback_supplement__
  

Changed:
  U   Zope3/trunk/src/zope/exceptions/interfaces.py

-=-
Modified: Zope3/trunk/src/zope/exceptions/interfaces.py
===================================================================
--- Zope3/trunk/src/zope/exceptions/interfaces.py	2006-01-27 22:59:20 UTC (rev 41469)
+++ Zope3/trunk/src/zope/exceptions/interfaces.py	2006-01-27 23:31:30 UTC (rev 41470)
@@ -14,6 +14,21 @@
 """ITracebackSupplement interface definition.
 
 $Id$
+
+When zope.exceptionformatter generates a traceback, it looks for local
+variables named __traceback_info__ or __traceback_supplement__.  It
+includes the information provided by those local variables in the
+traceback.
+
+__traceback_info__ is for arbitrary information.
+repr(__traceback_info__) gets dumped to the traceback.
+
+__traceback_supplement__ is more structured.  It should be a tuple.
+The first item of the tuple is a callable that produces an object that
+implements ITracebackSupplement, and the rest of the tuple contains
+arguments to pass to the factory.  The traceback formatter makes an
+effort to clearly present the information provided by the
+ITracebackSupplement.
 """