[Docstring-checkins] CVS: dps/dps/transforms __init__.py,1.3,1.4

[David G. <go...@us...>]

Update of /cvsroot/docstring/dps/dps/transforms
In directory usw-pr-cvs1:/tmp/cvs-serv25511/dps/dps/transforms

Modified Files:
	__init__.py 
Log Message:
Updated the transform API with a "startnode" parameter;
changed calling conventions.

Index: __init__.py
===================================================================
RCS file: /cvsroot/docstring/dps/dps/transforms/__init__.py,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** __init__.py	6 Feb 2002 02:51:25 -0000	1.3
--- __init__.py	16 Mar 2002 06:02:00 -0000	1.4
***************
*** 38,47 ****
  class Transform:
  
!     def transform(self, doctree):
!         """Override to transform the document tree."""
!         raise NotImplementedError('subclass must override this method')
  
-     def setup_transform(self, doctree):
-         """Initial setup, used by `self.transform()`."""
          self.doctree = doctree
          self.language = languages.getlanguage(doctree.languagecode)
--- 38,62 ----
  class Transform:
  
!     """
!     Docutils transform component abstract base class.
!     """
! 
!     def __init__(self, doctree, startnode=None):
!         """
!         Initial setup for in-place document transforms.
!         """
  
          self.doctree = doctree
+         """The document tree to transform."""
+ 
+         self.startnode = startnode
+         """Node from which to begin the transform.  For many transforms which
+         apply to the document as a whole, `startnode` is not set (i.e. its
+         value is `None`)."""
+ 
          self.language = languages.getlanguage(doctree.languagecode)
+         """Language module local to this document."""
+ 
+     def transform(self):
+         """Override to transform the document tree."""
+         raise NotImplementedError('subclass must override this method')