Added structured text consensus.
This commit is contained in:
parent
0b15ededdb
commit
94b08d33bb
17
pep-0216.txt
17
pep-0216.txt
|
@ -85,6 +85,23 @@ Docstring Contents
|
|||
d. Emphasis/bold
|
||||
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
|
||||
|
||||
XML -- it's very hard to type, and too cluttered to read it
|
||||
|
|
Loading…
Reference in New Issue