[Numpy-discussion] [SciPy-dev] Doc-day
Stefan van der Walt
stefan at sun.ac.za
Fri Dec 28 19:25:35 EST 2007
On Fri, Dec 28, 2007 at 11:32:03AM -0600, Travis E. Oliphant wrote:
> I don't see the point in every file having a __docformat__ line, when
> our documentaion formatting tool should already know the standard we are
> using is. It's just more cruft. Besides the PEP was rejected, so I
> don't know why we should be following it.
Sorry, I didn't see the PEP was rejected. Moot point, then.
> We obviously need a pre-processor to map our files to epydoc, so let's
> do that instead of contorting docstrings into a format demanded by the
> tool.
That's a good idea, thanks. I'll take a look.
> It seems better to have docstrings than to have them fit into an
> epydoc_-defined pattern.
Certainly.
Thanks for the feedback.
Regards
Stéfan
More information about the NumPy-Discussion
mailing list