[SciPy-user] Docstring standards for NumPy and SciPy

Robert Kern robert.kern at gmail.com
Fri Jan 12 13:58:20 CST 2007


Neal Becker wrote:

> I'd just like to add, that a number of posts have advocated for a design
> where docstrings are read via parsing instead of introspection. 
> Unfortunately, we need to document objects written in languages other than
> python (C, C++).  A hybrid system is possible (use parsing when possible,
> revert to introspection), but a system that only uses parsing doesn't meet
> the requirements.

And for what it's worth, epydoc 3 is just such a hybrid system.

-- 
Robert Kern

"I have come to believe that the whole world is an enigma, a harmless enigma
 that is made terrible by our own mad attempt to interpret it as though it had
 an underlying truth."
  -- Umberto Eco


More information about the SciPy-user mailing list