[Docstring-checkins] CVS: dps/spec pep-0256.txt,1.1.1.1,1.2

[David G. <go...@us...>]

Update of /cvsroot/docstring/dps/spec
In directory usw-pr-cvs1:/tmp/cvs-serv19164/dps/spec

Modified Files:
	pep-0256.txt 
Log Message:
added ref to Ed Loper's STminus; added "methods" to abstract

Index: pep-0256.txt
===================================================================
RCS file: /cvsroot/docstring/dps/spec/pep-0256.txt,v
retrieving revision 1.1.1.1
retrieving revision 1.2
diff -C2 -d -r1.1.1.1 -r1.2
*** pep-0256.txt	2001/07/22 22:36:18	1.1.1.1
--- pep-0256.txt	2001/08/04 15:44:49	1.2
***************
*** 13,22 ****
  Abstract
  
!     Python modules, classes and functions have a string attribute
!     called __doc__.  If the first expression inside the definition is
!     a literal string, that string is assigned to the __doc__
!     attribute, called a documentation string or docstring.  It is
!     often used to summarize the interface of the module, class or
!     function.
  
      There is no standard format (markup) for docstrings, nor are there
--- 13,22 ----
  Abstract
  
!     Python modules, functions, classes and methods have a string
!     attribute called __doc__.  If the first expression inside their
!     definition is a literal string, that string is assigned to the
!     __doc__ attribute, called a documentation string or docstring.  It
!     is often used to summarize the interface of the module, function,
!     class or method.
  
      There is no standard format (markup) for docstrings, nor are there
***************
*** 71,74 ****
--- 71,76 ----
      - Tony Ibbs' docutils [7]
  
+     - Edward Loper's STminus formalization and related efforts [8]
+ 
      These systems, each with different goals, have had varying degrees
      of success.  A problem with many of the above systems was
***************
*** 80,84 ****
  
      Throughout the existence of the Python Documentation Special
!     Interest Group (Doc-SIG) [8], consensus on a single standard
      docstring format has never been reached.  A lightweight, implicit
      markup has been sought, for the following reasons (among others):
--- 82,86 ----
  
      Throughout the existence of the Python Documentation Special
!     Interest Group (Doc-SIG) [9], consensus on a single standard
      docstring format has never been reached.  A lightweight, implicit
      markup has been sought, for the following reasons (among others):
***************
*** 99,104 ****
         minimalist Python syntax.
  
!     Early on, variants of Setext (Structure Enhanced Text) [9],
!     including Digital Creation's StructuredText [10], were proposed
      for Python docstring formatting.  Hereafter we will collectively
      call these variants 'STexts'.  Although used by some (including in
--- 101,106 ----
         minimalist Python syntax.
  
!     Early on, variants of Setext (Structure Enhanced Text) [10],
!     including Digital Creation's StructuredText [11], were proposed
      for Python docstring formatting.  Hereafter we will collectively
      call these variants 'STexts'.  Although used by some (including in
***************
*** 181,185 ****
         - First line is a one-line synopsis.
  
!        PEP 257, Docstring Conventions [11], documents these issues.
  
      2. Docstring processing system generic implementation details.
--- 183,187 ----
         - First line is a one-line synopsis.
  
!        PEP 257, Docstring Conventions [12], documents these issues.
  
      2. Docstring processing system generic implementation details.
***************
*** 205,209 ****
         These issues are applicable to any docstring processing system
         implementation.  PEP 258, DPS Generic Implementation Details
!        [12], documents these issues.
  
      3. Docstring processing system implementation.
--- 207,211 ----
         These issues are applicable to any docstring processing system
         implementation.  PEP 258, DPS Generic Implementation Details
!        [13], documents these issues.
  
      3. Docstring processing system implementation.
***************
*** 276,292 ****
      [7] http://homepage.ntlworld.com/tibsnjoan/docutils/
  
!     [8] http://www.python.org/sigs/doc-sig/
  
!     [9] http://www.bsdi.com/setext/
  
!     [10] http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage/
  
!     [11] PEP 257, Docstring Conventions, Goodger, Van Rossum
           http://www.python.org/peps/pep-0257.html
  
!     [12] PEP 258, DPS Generic Implementation Details, Goodger
           http://www.python.org/peps/pep-0258.html
  
!     [13] PEP 216, Docstring Format, Zadka
           http://www.python.org/peps/pep-0216.html
  
--- 278,296 ----
      [7] http://homepage.ntlworld.com/tibsnjoan/docutils/
  
!     [8] http://www.cis.upenn.edu/~edloper/pydoc/
  
!     [9] http://www.python.org/sigs/doc-sig/
  
!     [10] http://www.bsdi.com/setext/
  
!     [11] http://dev.zope.org/Members/jim/StructuredTextWiki/FrontPage/
! 
!     [12] PEP 257, Docstring Conventions, Goodger, Van Rossum
           http://www.python.org/peps/pep-0257.html
  
!     [13] PEP 258, DPS Generic Implementation Details, Goodger
           http://www.python.org/peps/pep-0258.html
  
!     [14] PEP 216, Docstring Format, Zadka
           http://www.python.org/peps/pep-0216.html
  
***************
*** 301,305 ****
  
      This document borrows text from PEP 216, Docstring Format, by
!     Moshe Zadka [13].  It is intended as a reorganization of PEP 216
      and its approach.
  
--- 305,309 ----
  
      This document borrows text from PEP 216, Docstring Format, by
!     Moshe Zadka [14].  It is intended as a reorganization of PEP 216
      and its approach.