PEP 426: make summary field mandatory

This commit is contained in:
Nick Coghlan 2013-06-24 21:05:51 +10:00
parent 41306e137b
commit a157a40e52
1 changed files with 20 additions and 20 deletions

View File

@ -566,6 +566,24 @@ Example::
"version": "1.0a2" "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 Source code metadata
==================== ====================
@ -658,26 +676,6 @@ a distribution does not provide them, including failing cleanly when an
operation depending on one of these fields is requested. 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 License
------- -------
@ -692,6 +690,8 @@ indicate any variations or exception to the license.
This field SHOULD contain fewer than 512 characters and MUST contain fewer This field SHOULD contain fewer than 512 characters and MUST contain fewer
than 2048. than 2048.
This field SHOULD NOT contain any line breaks.
The full license text SHOULD be included as a separate file in the source The full license text SHOULD be included as a separate file in the source
archive for the distribution. See `Document names`_ for details. archive for the distribution. See `Document names`_ for details.