[Python-checkins] python/dist/src/Doc/lib libdoctest.tex,1.15,1.16

fdrake@users.sourceforge.net fdrake@users.sourceforge.net
Thu, 17 Jul 2003 08:22:49 -0700


Update of /cvsroot/python/python/dist/src/Doc/lib
In directory sc8-pr-cvs1:/tmp/cvs-serv24106

Modified Files:
	libdoctest.tex 
Log Message:
- remove mention of the isprivate flag, since that isn't directly
  documented here, and according to Tim, should never have been there
- misc. cleanups for consistency


Index: libdoctest.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libdoctest.tex,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** libdoctest.tex	17 Jul 2003 14:47:12 -0000	1.15
--- libdoctest.tex	17 Jul 2003 15:22:47 -0000	1.16
***************
*** 174,179 ****
  \end{verbatim}
  
! and a detailed report of all examples tried is printed to \code{stdout},
! along with assorted summaries at the end.
  
  You can force verbose mode by passing \code{verbose=1} to
--- 174,179 ----
  \end{verbatim}
  
! and a detailed report of all examples tried is printed to standard
! output, along with assorted summaries at the end.
  
  You can force verbose mode by passing \code{verbose=1} to
***************
*** 189,200 ****
  \subsection{Which Docstrings Are Examined?}
  
! See \file{docstring.py} for all the details.  They're unsurprising:  the
! module docstring, and all function, class and method docstrings are
! searched.  Optionally, the tester can be directed to exclude
! docstrings attached to objects with private names.
! Objects imported into the module are not searched.
! \versionchanged[Previously, the tester defaulted to skipping objects
! with private names (to obtain version independence, explicitly specify
! \var{isprivate} when launching doctests)]{2.3}
  
  In addition, if \code{M.__test__} exists and "is true", it must be a
--- 189,197 ----
  \subsection{Which Docstrings Are Examined?}
  
! See the docstrings in \file{doctest.py} for all the details.  They're
! unsurprising: the module docstring, and all function, class and method
! docstrings are searched.  Optionally, the tester can be directed to
! exclude docstrings attached to objects with private names.  Objects
! imported into the module are not searched.
  
  In addition, if \code{M.__test__} exists and "is true", it must be a
***************
*** 206,210 ****
  
  \begin{verbatim}
!       <name of M>.__test__.K
  \end{verbatim}
  
--- 203,207 ----
  
  \begin{verbatim}
! <name of M>.__test__.K
  \end{verbatim}
  
***************
*** 260,264 ****
    The doctest examples are extracted (see function \function{testsource()}),
    and written to a temporary file.  The Python debugger, \refmodule{pdb},
!   is then invoked on that file.    
    \versionadded{2.3}
  \end{funcdesc}
--- 257,261 ----
    The doctest examples are extracted (see function \function{testsource()}),
    and written to a temporary file.  The Python debugger, \refmodule{pdb},
!   is then invoked on that file.
    \versionadded{2.3}
  \end{funcdesc}
***************
*** 271,275 ****
  
    To get finer control than \function{testmod()} offers, create an instance
!   of \class{Tester} with custom policies and run the methods of \code{master}
    directly.  See \code{Tester.__doc__} for details.
  \end{funcdesc}
--- 268,272 ----
  
    To get finer control than \function{testmod()} offers, create an instance
!   of \class{Tester} with custom policies, or run methods of \code{master}
    directly.  See \code{Tester.__doc__} for details.
  \end{funcdesc}
***************
*** 300,304 ****
    The optional \var{module} argument provides the module to be tested.  It
    can be a module object or a (possibly dotted) module name.  If not
!   specified, the module calling \function{DocTestSuite()} is used.
  
    Example using one of the many ways that the \refmodule{unittest} module
--- 297,301 ----
    The optional \var{module} argument provides the module to be tested.  It
    can be a module object or a (possibly dotted) module name.  If not
!   specified, the module calling this function is used.
  
    Example using one of the many ways that the \refmodule{unittest} module
***************
*** 316,320 ****
  
    \versionadded{2.3}
!   \warning{\function{DocTestSuite()} does not current search \code{M.__test__}
    and its search technique does not exactly match \function{testmod()} in
    every detail.  Future versions will bring the two into convergence.}
--- 313,317 ----
  
    \versionadded{2.3}
!   \warning{This function does not currently search \code{M.__test__}
    and its search technique does not exactly match \function{testmod()} in
    every detail.  Future versions will bring the two into convergence.}