I'm using epydoc to check and enforce documentation completeness for a
project. It seems that when I check the documentation of functions with
the following combination of checks --
DocChecker.FUNC | DocChecker.DESCR | DocChecker.RETURN |
-- epydoc will complain that "Argument(s) not described" if the
parameter 'self' is not documented. Since 'self' means the same thing
in pretty much every function in existence, this contributes nothing but
noise to the docstrings. I'm wondering if there is an easy way to shut
For reference, I am not using 'epydoc --check' directly, but rather
importing what I need, building a DocIndex, attaching it to a
DocChecker, and running the checks on it from Python.
Get latest updates about Open Source Projects, Conferences and News.