[Python-Dev] PEP 287: reStructuredText Standard Docstring Format

Samuele Pedroni pedroni@inf.ethz.ch
Sat, 6 Apr 2002 07:15:51 +0200

From: Samuele Pedroni <pedroni@inf.ethz.ch>
>From David Abrahams <david.abrahams@rcn.com>
> > 
> > Is it just me, or are docstrings less-convenient than comments? Any
> > thought given to reST-processing a module's comments?
> > 
> Maybe it's just me but I would be more happy to optionally
> be able to write reST inside comments instead of docstrings
> and have it extracted from there. That means
> the comment would take the place of the secondary
> docstring.

that means optionally e.g:

# identifiable heavy reST 
def f(...
  """plain text or light reST"""


def f(..
  """plain text or light reST"""
  """heavy reST"""