[Python-checkins] CVS: python/nondist/peps pep-0216.txt,1.5,1.6

[Moshe Zadka]

Update of /cvsroot/python/python/nondist/peps
In directory slayer.i.sourceforge.net:/tmp/cvs-serv9880

Modified Files:
	pep-0216.txt 
Log Message:
Added some examples.
Clarified the fact I'm talking about ST-NG.


Index: pep-0216.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/peps/pep-0216.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -r1.5 -r1.6
*** pep-0216.txt	2000/11/10 00:06:39	1.5
--- pep-0216.txt	2000/11/10 13:17:48	1.6
***************
*** 81,85 ****
--- 81,95 ----
  
      a. A tag that means "this is a Python ``something'', guess what"
+ 
+     Example: In the sentence "The POP3 class", we need to markup "POP3"
+     so. The parser will be able to guess it is a class from the contents
+     of the poplib module, but we need to make it guess.
+ 
      b. Tags that mean "this is a Python class/module/class var/instance var..."
+ 
+     Example: In the sentence "This can be a regular file or a StringIO object" 
+     we need to markup "StringIO" as a Python class (the guesser might guess
+     it to be a module by mistake).
+ 
      c. An easy way to include Python source code/Python interactive sessions
      d. Emphasis/bold
***************
*** 88,92 ****
  Docstring Basic Structure
  
!     The documentation strings will be in StructuredText 
      (http://www.zope.org/Members/jim/StructuredTextWiki/StructuredTextNG)
      Since StructuredText is not yet strong enough to handle (a) and (b)
--- 98,102 ----
  Docstring Basic Structure
  
!     The documentation strings will be in StructuredTextNG
      (http://www.zope.org/Members/jim/StructuredTextWiki/StructuredTextNG)
      Since StructuredText is not yet strong enough to handle (a) and (b)