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

Moshe Zadka python-dev@python.org
Tue, 7 Nov 2000 01:11:07 -0800


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

Modified Files:
	pep-0216.txt 
Log Message:
Added structured text consensus.


Index: pep-0216.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/peps/pep-0216.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** pep-0216.txt	2000/11/05 16:48:55	1.3
--- pep-0216.txt	2000/11/07 09:11:04	1.4
***************
*** 86,89 ****
--- 86,106 ----
      e. List/tables
  
+ 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)
+     above, we will need to extend it. I suggest using 
+     '[<optional description>:python identifier]'. 
+     E.g.: [class:POP3], [:POP3.list], etc. If the description is missing,
+     a guess will be made from the text.
+ 
+ Unresolved Issues
+       
+     How do we describe input and output types of functions?
+ 
+     What additional constraint do we enforce on each docstring? 
+     (module/class/function)?
+ 
  Rejected Suggestions