[Python-checkins] peps: PEP 426: make summary field mandatory

nick.coghlan python-checkins at python.org
Mon Jun 24 13:06:03 CEST 2013


http://hg.python.org/peps/rev/14818873634f
changeset:   4960:14818873634f
user:        Nick Coghlan <ncoghlan at gmail.com>
date:        Mon Jun 24 21:05:51 2013 +1000
summary:
  PEP 426: make summary field mandatory

files:
  pep-0426.txt |  40 ++++++++++++++++++++--------------------
  1 files changed, 20 insertions(+), 20 deletions(-)


diff --git a/pep-0426.txt b/pep-0426.txt
--- a/pep-0426.txt
+++ b/pep-0426.txt
@@ -566,6 +566,24 @@
     "version": "1.0a2"
 
 
+Summary
+-------
+
+A short summary of what the distribution does.
+
+This field SHOULD contain fewer than 512 characters and MUST contain fewer
+than 2048.
+
+This field SHOULD NOT contain any line breaks.
+
+A more complete description SHOULD be included as a separate file in the
+sdist for the distribution. See `Document names`_ for details.
+
+Example::
+
+    "summary": "A module that is more fiendish than soft cushions."
+
+
 Source code metadata
 ====================
 
@@ -658,26 +676,6 @@
 operation depending on one of these fields is requested.
 
 
-Summary
--------
-
-A one-line summary of what the distribution does.
-
-Publication tools SHOULD emit a warning if this field is not provided. Index
-servers MAY require that this field be provided before allowing a
-distribution to be uploaded.
-
-This field SHOULD contain fewer than 512 characters and MUST contain fewer
-than 2048.
-
-A more complete description SHOULD be included as a separate file in the
-sdist for the distribution. See `Document names`_ for details.
-
-Example::
-
-    "summary": "A module that is more fiendish than soft cushions."
-
-
 License
 -------
 
@@ -692,6 +690,8 @@
 This field SHOULD contain fewer than 512 characters and MUST contain fewer
 than 2048.
 
+This field SHOULD NOT contain any line breaks.
+
 The full license text SHOULD be included as a separate file in the source
 archive for the distribution. See `Document names`_ for details.
 

-- 
Repository URL: http://hg.python.org/peps


More information about the Python-checkins mailing list