improving the PEP readability

pep-0345.txt

@@ -44,6 +44,8 @@ not required to appear in a valid PKG-INFO file; all other
 fields must be present.
 
 Metadata-Version
+::::::::::::::::
+
 Version of the file format; "1.0", "1.1" and "1.2" are the
 only legal values here.
 
@@ -51,14 +53,20 @@ Metadata-Version
 
     Metadata-Version: 1.2
 
+
 Name
+::::
+
 The name of the package.
 
 Example::
 
     Name: BeagleVote
 
+
 Version
+:::::::
+
 A string containing the package's version number.  This
 field  must be in the format specified in `PEP 386`_.
 
@@ -66,7 +74,10 @@ Version
 
     Version: 1.0a2
 
+
 Platform (multiple use)
+:::::::::::::::::::::::
+
 A comma-separated list of platform specifications, summarizing
 the operating systems supported by the package which are not
 listed in the "Operating System" Trove classifiers. See
@@ -76,7 +87,10 @@ Platform (multiple use)
 
     Platform: ObscureUnix, RareDOS
 
+
 Supported-Platform (multiple use)
+:::::::::::::::::::::::::::::::::
+
 Binary distributions containing a PKG-INFO file will use the
 Supported-Platform field in their metadata to specify the OS and
 CPU for which the binary package was compiled.  The semantics of
@@ -87,14 +101,20 @@ Supported-Platform (multiple use)
     Supported-Platform: RedHat 7.2
     Supported-Platform: i386-win32-2791
 
+
 Summary
+:::::::
+
 A one-line summary of what the package does.
 
 Example::
 
     Summary: A module for collecting votes from beagles.
 
+
 Description (optional)
+::::::::::::::::::::::
+
 A longer description of the package that can run to several
 paragraphs.  Software that deals with metadata should not assume
 any maximum size for this field, though people shouldn't include
@@ -113,7 +133,10 @@ Description (optional)
                 Do *not* try to use this module with basset hounds;
                 it makes them grumpy.
 
+
 Keywords (optional)
+:::::::::::::::::::
+
 A list of additional keywords to be used to assist searching
 for the package in a larger catalog.
 
@@ -121,19 +144,28 @@ Keywords (optional)
 
     Keywords: dog puppy voting election
 
+
 Home-page (optional)
+::::::::::::::::::::
+
 A string containing the URL for the package's home page.
 
 Example::
 
     Home-page: http://www.example.com/~cschultz/bvote/
 
+
 Download-URL
+::::::::::::
+
 A string containing the URL from which this version of the package
 can be downloaded.  (This means that the URL can't be something like
 ".../package-latest.tgz", but instead must be ".../package-0.45.tgz".)
 
+
 Author (optional)
+:::::::::::::::::
+
 A string containing the author's name at a minimum; additional
 contact information may be provided.
 
@@ -142,7 +174,10 @@ Author (optional)
     Author: C. Schultz, Universal Features Syndicate,
             Los Angeles, CA <cschultz@peanuts.example.com>
 
+
 Author-email
+::::::::::::
+
 A string containing the author's e-mail address.  It can contain
 a name and e-mail address in the legal forms for a RFC-822
 ``From:`` header.  It's not optional because cataloging systems
@@ -158,7 +193,10 @@ Author-email
 
     Author-email: "C. Schultz" <cschultz@example.com>
 
+
 Maintainer (optional)
+:::::::::::::::::::::
+
 A string containing the maintainer's name at a minimum; additional
 contact information may be provided.
 
@@ -171,7 +209,10 @@ Maintainer (optional)
     Maintainer: C. Schultz, Universal Features Syndicate,
             Los Angeles, CA <cschultz@peanuts.example.com>
 
+
 Maintainer-email (optional)
+:::::::::::::::::::::::::::
+
 A string containing the maintainer's e-mail address.  It can contain
 a name and e-mail address in the legal forms for a RFC-822
 ``From:`` header.
@@ -184,7 +225,10 @@ Maintainer-email (optional)
 
     Maintainer-email: "C. Schultz" <cschultz@example.com>
 
+
 License (optional)
+::::::::::::::::::
+
 Text indicating the license covering the package where the license
 is not a selection from the "License" Trove classifiers. See
 "Classifier" below.  This field may also be used to specify a
@@ -199,7 +243,10 @@ License (optional)
 
     License: GPL version 3, excluding DRM provisions
 
+
 Classifier (multiple use)
+:::::::::::::::::::::::::
+
 Each entry is a string giving a single classification value
 for the package.  Classifiers are described in PEP 301 [2].
 
@@ -208,7 +255,12 @@ Classifier (multiple use)
     Classifier: Development Status :: 4 - Beta
     Classifier: Environment :: Console (Text Based)
 
-Requires (multiple use)
+
+Requires (multiple use) (deprecated)
+::::::::::::::::::::::::::::::::::::
+
+**This field is now deprecated in favor of "Requires-Dist"**
+
 Each entry contains a string describing some other module or
 package required by this package.
 
@@ -242,9 +294,12 @@ Requires (multiple use)
     Requires: xml.parsers.expat (>1.0)
     Requires: psycopg
 
-    Note:  this field is now deprecated in favor of ``Requires-Dist``.
 
-Provides (multiple use)
+Provides (multiple use) (deprecated)
+::::::::::::::::::::::::::::::::::::
+
+**This field is now deprecated in favor of "Provides-Dist"**
+
 Each entry contains a string describing a package or module that
 will be provided by this package once it is installed.  These
 strings should match the ones used in Requirements fields.  A
@@ -260,9 +315,12 @@ Provides (multiple use)
     Provides: xml.dom
     Provides: xmltools (1.3)
 
-    Note:  this field is now deprecated in favor of ``Provides-Dist``.
 
-Obsoletes (multiple use)
+Obsoletes (multiple use) (deprecated)
+:::::::::::::::::::::::::::::::::::::
+
+**This field is now deprecated in favor of "Obsoletes-Dist"**
+
 Each entry contains a string describing a package or module
 that this package renders obsolete, meaning that the two packages
 should not be installed at the same time.  Version declarations
@@ -277,9 +335,10 @@ Obsoletes (multiple use)
 
     Obsoletes: Gorgon
 
-    Note:  this field is now deprecated in favor of ``Obsoletes-Dist``.
 
 Requires-Dist (multiple use)
+::::::::::::::::::::::::::::
+
 Each entry contains a string naming some other distutils
 project required by this package.
 
@@ -306,7 +365,10 @@ Requires-Dist (multiple use)
     Requires-Dist: PasteDeploy
     Requires-Dist: zope.interface (>3.5.0)
 
+
 Provides-Dist (multiple use)
+::::::::::::::::::::::::::::
+
 Each entry contains a string naming a distutlis project which
 is contained within this distribution.  This field *must* include
 the project identified in the ``Name`` field.
@@ -337,7 +399,10 @@ Provides-Dist (multiple use)
     Provides-Dist: AnotherPackage (3.4)
     Provides-Dist: virtual_package
 
+
 Obsoletes-Dist (multiple use)
+:::::::::::::::::::::::::::::
+
 Each entry contains a string describing a distutils project which
 this package renders obsolete, meaning that the two packages
 should not be installed at the same time.
@@ -355,7 +420,10 @@ Obsoletes-Dist (multiple use)
     Obsoletes-Dist: Gorgon
     Obsoletes-Dist: OtherPackage (<3.0)
 
+
 Requires-Python
+:::::::::::::::
+
 This field specifies the Python version(s) that the package is
 guaranteed to be compatible with. The format of the field is a
 series of conditional operators and version numbers, separated
@@ -374,7 +442,10 @@ Requires-Python
     Requires-Python: >=2.3.4
     Requires-Python: 2.5, 2.6
 
+
 Requires-External (multiple use)
+::::::::::::::::::::::::::::::::
+
 Each entry contains a string describing some dependency in the
 system that the package is to be used.  This field is intended to
 serve as a hint to downstream package maintainers, and has no
@@ -406,6 +477,8 @@ Requires-External (multiple use)
 
 
 Copyright
+:::::::::
+
 Indicates the party or parties, and the year of copyright
 covering the package.
 
@@ -416,7 +489,9 @@ Copyright
     Copyright: Public Domain
 
 
-Project-URL (multiple-use) :
+Project-URL (multiple-use)
+::::::::::::::::::::::::::
+
 A string containing a browsable URL for the project and a label for it,
 separated by a comma.