[Python-checkins] python/dist/src/Lib doctest.py, 1.36.2.17, 1.36.2.18

Fri Aug 6 03:28:56 CEST 2004

Update of /cvsroot/python/python/dist/src/Lib
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv30284/Lib
Modified Files:
 Tag: tim-doctest-branch
	doctest.py 
Log Message:
Added Edward's very helpful 30-second overview and class-flow diagram
from early email.
Index: doctest.py
===================================================================
RCS file: /cvsroot/python/python/dist/src/Lib/doctest.py,v
retrieving revision 1.36.2.17
retrieving revision 1.36.2.18
diff -C2 -d -r1.36.2.17 -r1.36.2.18
*** doctest.py	6 Aug 2004 01:01:55 -0000	1.36.2.17
--- doctest.py	6 Aug 2004 01:28:54 -0000	1.36.2.18
***************
*** 1,5 ****
 # Module doctest.
 # Released to the public domain 16-Jan-2001, by Tim Peters (tim at python.org).
! # Significant enhancements by:
 # Jim Fulton
 # Edward Loper
--- 1,5 ----
 # Module doctest.
 # Released to the public domain 16-Jan-2001, by Tim Peters (tim at python.org).
! # Major enhancements and refactoring by:
 # Jim Fulton
 # Edward Loper
***************
*** 331,334 ****
--- 331,354 ----
 ELLIPSIS_MARKER = '...'
 
+ 
+ # There are 4 basic classes:
+ # - Example: a <source, want> pair, plus an intra-docstring line number.
+ # - DocTest: a collection of examples, parsed from a docstring, plus
+ # info about where the docstring came from (name, filename, lineno).
+ # - DocTestFinder: extracts DocTests from a given object's docstring and
+ # its contained objects' docstrings.
+ # - DocTestRunner: runs DocTest cases, and accumulates statistics.
+ #
+ # So the basic picture is:
+ #
+ # list of:
+ # +------+ +---------+ +-------+
+ # |object| --DocTestFinder-> | DocTest | --DocTestRunner-> |results|
+ # +------+ +---------+ +-------+
+ # | Example |
+ # | ... |
+ # | Example |
+ # +---------+
+ 
 ######################################################################
 ## Table of Contents