epydoc-devel

[Epydoc-devel] turn off documentation of __new__, __repr__, etc.

[John D. <jd...@re...>]

I currently use epydoc for a CPython extension module (i.e. it's 
entirely written in C). Epydoc seems to always want to include 
documentation for things like __new__, __repr__, __str__, etc that 
really should be hidden from the user. The only thing the doc says is 
"Overrides: object.__repr__". It just clutters up the doc obscuring the 
important documentation.

How do I turn off or filter out that kind of "noisy" doc?

Also, for the __init__ method I always get this:

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

But the class is documented along with the __init__ parameters.

I do see a common thread, it seems like all the "noisy" useless doc are 
for things in CPython which do not have a way to associate a doc string 
(e.g. those things which are referenced by the PyTypeObject structure 
(i.e. tp_*).

Am I doing something wrong?

-- 
John Dennis <jd...@re...>

Looking to carve out IT costs?
www.redhat.com/carveoutcosts/

Re: [Epydoc-devel] turn off documentation of __new__, __repr__, etc.

[Daniele V. <dan...@gm...>]

On Fri, Jun 25, 2010 at 4:06 PM, John Dennis <jd...@re...> wrote:
> I currently use epydoc for a CPython extension module (i.e. it's
> entirely written in C). Epydoc seems to always want to include
> documentation for things like __new__, __repr__, __str__, etc that
> really should be hidden from the user. The only thing the doc says is
> "Overrides: object.__repr__". It just clutters up the doc obscuring the
> important documentation.

Hi,

can't remember if there's a switch to disable "magic" methods as it's
a long time I'm not using Epydoc. But maybe using --inheritance=listed
could reduce the clutter, as the docstrings you see are the ones
defined on "object".

-- Daniele