]> granicus.if.org Git - python/commitdiff
Docstring consistency with the updated .tex files.
authorBarry Warsaw <barry@python.org>
Mon, 30 Sep 2002 20:07:22 +0000 (20:07 +0000)
committerBarry Warsaw <barry@python.org>
Mon, 30 Sep 2002 20:07:22 +0000 (20:07 +0000)
Lib/email/Parser.py

index 98d20c3bdc471578af23ffd0f52a780109d9db38..119a90dbf4914176f2ddb8ff84238c1c197d7fa6 100644 (file)
@@ -49,6 +49,13 @@ class Parser:
         self._strict = strict
 
     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)
         if not headersonly:
@@ -56,6 +63,13 @@ class Parser:
         return root
 
     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)
 
     def _parseheaders(self, container, fp):