[Docstring-checkins] CVS: dps/dps core.py,1.2,1.3

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

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

Modified Files:
	core.py 
Log Message:
docstring mods

Index: core.py
===================================================================
RCS file: /cvsroot/docstring/dps/dps/core.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** core.py	7 Feb 2002 02:02:24 -0000	1.2
--- core.py	28 Mar 2002 04:47:16 -0000	1.3
***************
*** 21,24 ****
--- 21,28 ----
  class Publisher:
  
+     """
+     Publisher encapsulates the high-level logic of a Docutils system.
+     """
+ 
      reporter = None
      """A `utils.Reporter` instance used for all document processing."""
***************
*** 27,30 ****
--- 31,39 ----
                   languagecode='en', warninglevel=2, errorlevel=4,
                   warningstream=None, debug=0):
+         """
+         Initial setup.  If any of `reader`, `parser`, or `writer` are
+         not specified, the corresponding 'set*' method should be
+         called.
+         """
          self.reader = reader
          self.parser = parser
***************
*** 53,56 ****
--- 62,69 ----
  
      def publish(self, source, destination):
+         """
+         Run `source` through `self.reader`, then through `self.writer` to
+         `destination`.
+         """
          document = self.reader.read(source, self.parser)
          self.writer.write(document, destination)
***************
*** 63,66 ****
--- 76,80 ----
              reporter=None, languagecode='en',
              warninglevel=2, errorlevel=4, warningstream=None, debug=0):
+     """Set up & run a `Publisher`."""
      pub = Publisher(reader, parser, writer, reporter, languagecode,
                      warninglevel, errorlevel, warningstream, debug)