[Python-checkins] python/nondist/peps pep-0258.txt,1.5,1.6

goodger@users.sourceforge.net goodger@users.sourceforge.net
Sat, 21 Jun 2003 07:43:20 -0700


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

Modified Files:
	pep-0258.txt 
Log Message:
updated

Index: pep-0258.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/peps/pep-0258.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** pep-0258.txt	8 Nov 2002 04:26:56 -0000	1.5
--- pep-0258.txt	21 Jun 2003 14:43:18 -0000	1.6
***************
*** 187,191 ****
  the document tree.  Transforms change the document tree from one form
  to another, add to the tree, or prune it.  Transforms resolve
! references and footnote numbers, processing interpreted text, and do
  other context-sensitive processing.
  
--- 187,191 ----
  the document tree.  Transforms change the document tree from one form
  to another, add to the tree, or prune it.  Transforms resolve
! references and footnote numbers, process interpreted text, and do
  other context-sensitive processing.
  
***************
*** 367,377 ****
      classes.  See `Document Tree`_ below.
  
-   - Module "docutils.optik" provides option parsing and command-line
-     help; from Greg Ward's http://optik.sf.net/ project, included for
-     convenience.
- 
-   - Module "docutils.roman" contains Roman numeral conversion
-     routines.
- 
    - Module "docutils.statemachine" contains a finite state machine
      specialized for regular-expression-based text filters and parsers.
--- 367,370 ----
***************
*** 451,464 ****
      language-dependent strings and mappings.  They are named for their
      language identifier (as defined in `Choice of Docstring Format`_
!     above), converting dashes to underscores.
  
      - Function "get_language(language_code)", returns matching
        language module.  (``docutils/languages/__init__.py``)
  
!     - Modules: en.py (English), de.py (German), fr.py (French), sk.py
!       (Slovak), sv.py (Swedish).
  
      - Other languages to be added.
  
  
  Front-End Tools
--- 444,467 ----
      language-dependent strings and mappings.  They are named for their
      language identifier (as defined in `Choice of Docstring Format`_
!     below), converting dashes to underscores.
  
      - Function "get_language(language_code)", returns matching
        language module.  (``docutils/languages/__init__.py``)
  
!     - Modules: en.py (English), de.py (German), fr.py (French), it.py
!       (Italian), sk.py (Slovak), sv.py (Swedish).
  
      - Other languages to be added.
  
+ * Third-party modules: "extras" directory.  These modules are
+   installed only if they're not already present in the Python
+   installation.
+ 
+   - ``extras/optparse.py`` and ``extras/textwrap.py`` provide
+     option parsing and command-line help; from Greg Ward's
+     http://optik.sf.net/ project, included for convenience.
+ 
+   - ``extras/roman.py`` contains Roman numeral conversion routines.
+ 
  
  Front-End Tools
***************
*** 714,718 ****
  
     c) At the top level of the "``__init__``" method definition of a
!       class: an instance attribute.  (@@@ ``__new__`` methods?)
  
     Since each of the above contexts are at the top level (i.e., in the
--- 717,726 ----
  
     c) At the top level of the "``__init__``" method definition of a
!       class: an instance attribute.  Instance attributes assigned in
!       other methods are assumed to be implementation details.  (@@@
!       ``__new__`` methods?)
! 
!    d) A function attribute assignment at the top level of a module or
!       class definition.
  
     Since each of the above contexts are at the top level (i.e., in the
***************
*** 735,738 ****
--- 743,751 ----
        is a simple identifier as in 3a.
  
+    c) For context 1d above, the target must be of the form
+       "``name.attrib``", where "``name``" matches an already-defined
+       function or method name and "attrib" is a simple identifier as
+       in 3a.
+ 
  Blank lines may be used after attribute docstrings to emphasize the
  connection between the assignment and the docstring.
***************
*** 749,754 ****
--- 762,776 ----
  
          def __init__(self):
+             """Method __init__'s docstring."""
+ 
              self.i = 'instance attribute'
              """This is self.i's docstring."""
+ 
+     def f(x):
+         """Function f's docstring."""
+         return x**2
+ 
+     f.a = 1
+     """Function attribute f.a's docstring."""