[Python-checkins] CVS: python/dist/src/Doc/lib libcompilerlike.tex,1.1,1.2

[Eric S. Raymond]

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

Modified Files:
	libcompilerlike.tex 
Log Message:
Clean up some argument profiles, enrich the docstring.


Index: libcompilerlike.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/libcompilerlike.tex,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** libcompilerlike.tex	2001/08/18 09:24:38	1.1
--- libcompilerlike.tex	2001/08/20 13:16:30	1.2
***************
*** 32,36 ****
  generating error messages, but it could be arbitrary data.
  
! The second argument, is interpreted as a list of filenames.  The files
  are transformed in left to right order in the list. A filename
  consisting of a dash is interpreted as a directive to read from
--- 32,36 ----
  generating error messages, but it could be arbitrary data.
  
! The second argument is interpreted as a list of filenames.  The files
  are transformed in left to right order in the list. A filename
  consisting of a dash is interpreted as a directive to read from
***************
*** 60,65 ****
  and the exception is then passed upwards.
  
! \begin{funcdesc}{filefilter}{name, arguments, trans_data\optional{,trans_file}}
! Filter using a function taking the name and two file-object
  arguments. The function is expected to read data from the input file
  object, transform it, and write the data to the output file object.
--- 60,65 ----
  and the exception is then passed upwards.
  
! \begin{funcdesc}{filefilter}{name, file, arguments, trans_data\optional{,trans_file}}
! Filter using a function taking the name, filename, and two file-object
  arguments. The function is expected to read data from the input file
  object, transform it, and write the data to the output file object.
***************
*** 68,84 ****
  \end{funcdesc}
  
! \begin{funcdesc}{linefilter}{name,arguments,trans_data\optional{,trans_file}}
! Filter using a function taking the name and a string argument.  The return
! value of the function should be a string.  This function is applied to
! each line in the input file in turn; the return values become the
! lines of the transformed file.
  \end{funcdesc}
  
! \begin{funcdesc}{sponge}{name, arguments, trans_data\optional{, trans_file}}
! Filter using a function taking the name and a string argument.  The
! return value of the function should be a string. The function will be
! passed the entire contents of the input file as a string.  The string
! return value of the function will become the entire contents of the
! transformed file.
  \end{funcdesc}
  
--- 68,84 ----
  \end{funcdesc}
  
! \begin{funcdesc}{linefilter}{name, file, arguments,trans_data\optional{,trans_file}}
! Filter using a function taking the name, the filename, and a string
! argument.  The return value of the function should be a string.  This
! function is applied to each line in the input file in turn; the return
! values become the lines of the transformed file.
  \end{funcdesc}
  
! \begin{funcdesc}{sponge}{name, file, arguments, trans_data\optional{, trans_file}}
! Filter using a function taking the name, the filename, and a string
! argument.  The return value of the function should be a string. The
! function will be passed the entire contents of the input file as a
! string.  The string return value of the function will become the
! entire contents of the transformed file.
  \end{funcdesc}