Updates:
Summary: Pass coverage_doctest.py
Status: Accepted
Labels: Documentation
Blockedon: 1587 1949
Comment #2 on issue 294 by asmeurer: Pass coverage_doctest.py
http://code.google.com/p/sympy/issues/detail?id=294
So I noticed this old issue and I think it should be the official issue for
documentation coverage. Basically, like the OP says, every user
function/method/class should have a docstring and a doctest. In other
words, the bin/coverage_doctest.py script should pass. Right now, it
incorrectly reports on benchmark and test file functions, but these don't
need to be documented all the time IMO, so it should pass after applying
the following commit, which is in my current integration3 branch.
commit 8ad074feb7e555a7ee926828d4fb39e90d6f6093
Author: Aaron Meurer <asmeu...@gmail.com>
Date: Wed May 26 23:22:02 2010 -0600
Make bin/coverage_doctest.py skip test_ and bench_ files
It only skips when parsing a directory argument. If a test_ or bench_
file is explicitly given, it will be checked for doctests.
See also issue 1949 (and several others).
--
You received this message because you are subscribed to the Google Groups
"sympy-issues" group.
To post to this group, send email to sympy-iss...@googlegroups.com.
To unsubscribe from this group, send email to
sympy-issues+unsubscr...@googlegroups.com.
For more options, visit this group at
http://groups.google.com/group/sympy-issues?hl=en.
