[Python-checkins] r54796 - sandbox/trunk/pep0/TODO

[brett.cannon]

Author: brett.cannon
Date: Fri Apr 13 00:08:50 2007
New Revision: 54796

Modified:
   sandbox/trunk/pep0/TODO
Log:
Clean up todo list.  Separate out from discrepencies things that are from how
the index has been handled and are definitely not the script's fault.


Modified: sandbox/trunk/pep0/TODO
==============================================================================
--- sandbox/trunk/pep0/TODO	(original)
+++ sandbox/trunk/pep0/TODO	Fri Apr 13 00:08:50 2007
@@ -2,7 +2,7 @@
 ---------------------
 Compatibility with PEP numerical index only (no static text).
 
-* Type/status issues:
+* Type/status issues (might be inconsistencies between index and PEP):
     - 160: missing F
     - 206: missing W
     - 216: missing R
@@ -26,24 +26,12 @@
     - 3107: used A, expected F
     - 3104: used A
 
-* Titles are too long (use ellipsis?):
-    - 311
-    - 3001
-
-* Blank lines between spaces in count:
-    - 42/100
-    - 160/200
-    - Will be more than currently in index:
-        + 364/666
-        + 666/754
-        + 754/3000
-        + 3002/3099
-
 
 Functionality to add
 --------------------
 
 * Read PEPs as UTF-8.
+
 * Output static text for PEP 0.
     + Store Owners list in a data structure.
         - Support nicknames for PEP listing (e.g., "Guido van Rossum" ->
@@ -55,20 +43,49 @@
           maintained and considered up-to-date?
     + Store Key in data structure for easy mapping?
         - Would allow for easy validation that metadata is correct in PEPs.
+
 * Output PEP 0 with numerical PEP index.
+
 * Output PEP 0 with special sections.
+
 * Make sure that it is easy to identify which PEP triggered an error.
+    + Has all expected fields.
+    + Values in fields correct.
+    + Formatting correct.
+        - Plaintext.
+        - reST.
 
 
-To clean up PEPs
+Inconsistencies
 ----------------
-* Define (and enforce) consistency in Author field.
+* Author field
+    + Three different formats for author (two include an email address).
+    + Best to settle on a single format.
+        - Author names separated by commas.
+        - Maintain email addresses only in PEP index so as to always have
+          up-to-date address in a single location.
+
+* Counting gap in numerical index and a newline.
+    + 42/100, 160/200.
+    + No other spaces in the count are used (e.g., 666/754).
+    + Have no spaces, always have a space?
+    + Should jumps in thousands digit have more than a single newline?
+
+* Titles that are longer than allowed.
+    + 311, 3001.
+    + Use custom titles to fit.
+    + Possible solutions.
+        - Use ellipsis to shorten name for index?
+        - Just deal with some being longer than expected?
+
 * Empty PEPs are not in any way identified within the PEPs themselves.
     + Get rid of section and just consider rejected?
         - No longer accept empty PEPs, right?
+
 * Meta-PEPs are not noted as such within the PEPs.
     + Add a "Meta" option for "Type"?
-* Fix inconsistent usage of Status field.
-    + Some PEPs just say "Standard"; missing "Track".
-* Informational, meta, and process PEPs inconsistently have status listed in
-  index.
+
+* Status field.
+    + Not all PEPs use consistent names (e.g., some just say "Standard" instead
+    of "Standard Track").
+    + Status of PEPs not consistently listed in index.