[Python-checkins] r77056 - peps/trunk/pep-0345.txt

[tarek.ziade]

Author: tarek.ziade
Date: Fri Dec 25 14:29:11 2009
New Revision: 77056

Log:
added the encoding of reStructuredText Description - using a RFC822-compatible folding/unfolding technique

Modified:
   peps/trunk/pep-0345.txt

Modified: peps/trunk/pep-0345.txt
==============================================================================
--- peps/trunk/pep-0345.txt	(original)
+++ peps/trunk/pep-0345.txt	Fri Dec 25 14:29:11 2009
@@ -127,12 +127,25 @@
 field as-is.  This means that authors should be conservative in
 the markup they use.
 
+To support empty lines and lines with indentation with respect to
+the RFC 822 format, any new line has to be suffixed by 7 spaces
+followed by a pipe (`|`) char. As a result, the Description field is
+encoded into a folded field that can be interpreted by RFC822
+parser [2]_.
+
 Example::
 
-    Description: This module collects votes from beagles
-                in order to determine their electoral wishes.
-                Do *not* try to use this module with basset hounds;
-                it makes them grumpy.
+    Description: This project provides powerful math functions
+            |For example, you can use `sum()` to sum numbers:
+            |
+            |Example::
+            |
+            |    >>> sum(1, 2)
+            |    3
+            |
+
+This encoding implies that any occurences of ``\n |`` have to be replaced
+by ``\n`` when the field is unfolded using a RFC822 reader.
 
 
 Keywords (optional)
@@ -517,7 +530,8 @@
 
 .. _`PEP 386`: http://www.python.org/dev/peps/pep-0386
 
-
+.. [2] RFC 822 Long Header Fields:
+   http://www.freesoft.org/CIE/RFC/822/7.htm
 
 Copyright
 =========