[Python-checkins] r54834 - sandbox/trunk/pep0/pep0/parse.py

[brett.cannon]

Author: brett.cannon
Date: Sun Apr 15 05:36:58 2007
New Revision: 54834

Modified:
   sandbox/trunk/pep0/pep0/parse.py
Log:
Explain in more detail what pep0.parse is expected to do.


Modified: sandbox/trunk/pep0/pep0/parse.py
==============================================================================
--- sandbox/trunk/pep0/pep0/parse.py	(original)
+++ sandbox/trunk/pep0/pep0/parse.py	Sun Apr 15 05:36:58 2007
@@ -1,5 +1,13 @@
 """Parse the metadata from a PEP file.
 
+Parsing consists of several steps:
+
+    * Detecting and reading all lines of text relating to metadata.
+    * Concatenating multi-line metadata for a single field into a single line.
+    * Validate PEP number (needed for future error reporting).
+        + Must be an integer.
+        + Must match file name.
+
 XXX
     * Remove metadata validation and move to pep class.
         + Still validate PEP number is an integer (it's needed for error