iSharkFly-Open
/
python-peps
mirror of https://github.com/python/peps.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Mention use of reST in description

This commit is contained in:
Andrew M. Kuchling 2003-05-07 16:53:28 +00:00
parent 17c3308718
commit 48acc6046b
1 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
pep-0314.txt
View File

@ -115,16 +115,21 @@ Fields
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 one hopes that
people won't include their instruction manual as the
description.)
paragraphs. Software that deals with metadata should not assume
any maximum size for this field, though people shouldn't include
their instruction manual as the description.
The contents of this field can be written using reStructuredText
markup [1]. For programs that work with the metadata,
supporting markup is optional; programs can also display the
contents of the field as-is. This means that authors should be
conservative in the markup they use.
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;
Do *not* try to use this module with basset hounds;
it makes them grumpy.
Keywords (optional)
@ -230,7 +235,7 @@ Fields
Classifier (multiple use)
Each entry is a string giving a single classification value
for the package. Classifiers are described in PEP 301 [1].
for the package. Classifiers are described in PEP 301 [2].
Examples:
@ -338,12 +343,15 @@ Open issues
Acknowledgements
None yet.
Richard Jones suggested using reST for the Description field.
References
[1] PEP 301
[1] reStructured text
http://docutils.sourceforge.net/
[2] PEP 301
http://www.python.org/peps/pep-0301.html