[Python-checkins] python/dist/src/Lib/email Parser.py,1.15,1.16

[barry@users.sourceforge.net]

Update of /cvsroot/python/python/dist/src/Lib/email
In directory usw-pr-cvs1:/tmp/cvs-serv29646

Modified Files:
	Parser.py 
Log Message:
Docstring consistency with the updated .tex files.


Index: Parser.py
===================================================================
RCS file: /cvsroot/python/python/dist/src/Lib/email/Parser.py,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -d -r1.15 -r1.16
*** Parser.py	28 Sep 2002 20:44:58 -0000	1.15
--- Parser.py	30 Sep 2002 20:07:22 -0000	1.16
***************
*** 50,53 ****
--- 50,60 ----
  
      def parse(self, fp, headersonly=False):
+         """Create a message structure from the data in a file.
+ 
+         Reads all the data from the file and returns the root of the message
+         structure.  Optional headersonly is a flag specifying whether to stop
+         parsing after reading the headers or not.  The default is False,
+         meaning it parses the entire contents of the file.
+         """
          root = self._class()
          self._parseheaders(root, fp)
***************
*** 57,60 ****
--- 64,74 ----
  
      def parsestr(self, text, headersonly=False):
+         """Create a message structure from a string.
+ 
+         Returns the root of the message structure.  Optional headersonly is a
+         flag specifying whether to stop parsing after reading the headers or
+         not.  The default is False, meaning it parses the entire contents of
+         the file.
+         """
          return self.parse(StringIO(text), headersonly=headersonly)