[Python-checkins] python/nondist/peps pep-0314.txt,1.12,1.13

akuchling@users.sourceforge.net akuchling@users.sourceforge.net
Wed, 07 May 2003 09:53:31 -0700


Update of /cvsroot/python/python/nondist/peps
In directory sc8-pr-cvs1:/tmp/cvs-serv4120

Modified Files:
	pep-0314.txt 
Log Message:
Mention use of reST in description


Index: pep-0314.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/peps/pep-0314.txt,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** pep-0314.txt	7 May 2003 16:34:52 -0000	1.12
--- pep-0314.txt	7 May 2003 16:53:28 -0000	1.13
***************
*** 116,123 ****
  
        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.)
  
        Example: 
--- 116,128 ----
  
        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
!       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: 
***************
*** 125,129 ****
            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.
        
--- 130,134 ----
            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.
        
***************
*** 231,235 ****
  
        Each entry is a string giving a single classification value
!       for the package.  Classifiers are described in PEP 301 [1].
  
        Examples:
--- 236,240 ----
  
        Each entry is a string giving a single classification value
!       for the package.  Classifiers are described in PEP 301 [2].
  
        Examples:
***************
*** 339,348 ****
  Acknowledgements
  
!     None yet.        
  
  
  References
  
!     [1] PEP 301
          http://www.python.org/peps/pep-0301.html
  
--- 344,356 ----
  Acknowledgements
  
!     Richard Jones suggested using reST for the Description field.
  
  
  References
  
!     [1] reStructured text 
!         http://docutils.sourceforge.net/
! 
!     [2] PEP 301
          http://www.python.org/peps/pep-0301.html