[Python-checkins] CVS: python/dist/src/Doc/lib libfilecmp.tex,1.4,1.5

[Fred L. Drake]

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

Modified Files:
	libfilecmp.tex 
Log Message:

Add some text to make the dircmp object section more readable, and move
some stuff around.


Index: libfilecmp.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libfilecmp.tex,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** libfilecmp.tex	2001/01/18 10:44:08	1.4
--- libfilecmp.tex	2001/05/11 17:01:32	1.5
***************
*** 7,14 ****
  
  
! The \module{filecmp} module defines functions to compare files and directories,
! with various optional time/correctness trade-offs.
  
! The \module{filecmp} module defines the following function:
  
  \begin{funcdesc}{cmp}{f1, f2\optional{, shallow\optional{, use_statcache}}}
--- 7,14 ----
  
  
! The \module{filecmp} module defines functions to compare files and
! directories, with various optional time/correctness trade-offs.
  
! The \module{filecmp} module defines the following functions:
  
  \begin{funcdesc}{cmp}{f1, f2\optional{, shallow\optional{, use_statcache}}}
***************
*** 59,62 ****
--- 59,64 ----
  \subsection{The \protect\class{dircmp} class \label{dircmp-objects}}
  
+ \class{dircmp} instances are built using this constructor:
+ 
  \begin{classdesc}{dircmp}{a, b\optional{, ignore\optional{, hide}}}
  Construct a new directory comparison object, to compare the
***************
*** 66,69 ****
--- 68,73 ----
  \end{classdesc}
  
+ The \class{dircmp} class provides the following methods:
+ 
  \begin{methoddesc}[dircmp]{report}{}
  Print (to \code{sys.stdout}) a comparison between \var{a} and \var{b}.
***************
*** 80,83 ****
--- 84,96 ----
  \end{methoddesc}
  
+ 
+ The \class{dircmp} offers a number of interesting attributes that may
+ be used to get various bits of information about the directory trees
+ being compared.
+ 
+ Note that via \method{__getattr__()} hooks, all attributes are
+ computed lazilly, so there is no speed penalty if only those
+ attributes which are lightweight to compute are used.
+ 
  \begin{memberdesc}[dircmp]{left_list}
  Files and subdirectories in \var{a}, filtered by \var{hide} and
***************
*** 133,138 ****
  \class{dircmp} objects.
  \end{memberdesc}
- 
- Note that via \method{__getattr__()} hooks, all attributes are
- computed lazilly, so there is no speed penalty if only those
- attributes which are lightweight to compute are used.
--- 146,147 ----