[Doc-SIG] docstring grammar

Guido van Rossum guido@CNRI.Reston.VA.US
Fri, 03 Dec 1999 09:42:08 -0500

> Guido van Rossum wrote:
> > 
> > Hm...  C extensions are also the most dangerous (in some cases) to
> > import, and further more this restricts you to generating
> > documentiation for modules that actually work on your current
> > platform.  Not a good idea.

Paul Prescod replied:

> What I'm hearing is that C extensions should just NOT be documented
> inline. Perhaps the interperter should look for their docstrings in .pdc
> files...to be defined another day!!!

C extensions should still have doc strings, but these only serve a
function for interactive use, not to generate the separate

The separate documentation of C modules could be extracted in a
different way from the source -- but that's a separate problem.

--Guido van Rossum (home page: http://www.python.org/~guido/)