#8699: allow doctest coverage script to handle triple single quotes
-------------------------------+--------------------------------------------
Reporter: mvngu | Owner: tbd
Type: enhancement | Status: needs_review
Priority: minor | Milestone: sage-4.4
Component: doctest | Keywords:
Author: Minh Van Nguyen | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-------------------------------+--------------------------------------------
Changes (by newvalueoldvalue):
* status: new => needs_review
* author: => Minh Van Nguyen
Old description:
> As the subject says. See this [http://groups.google.com/group/sage-
> devel/browse_thread/thread/54de5b70bc7b18e3 sage-devel] thread for some
> background information.
>
> This might conflict with ticket #7716.
New description:
As the subject says. See this [http://groups.google.com/group/sage-
devel/browse_thread/thread/54de5b70bc7b18e3 sage-devel] thread for some
background information.
This might conflict with ticket #7716.
Apply patches in this order:
*
[http://trac.sagemath.org/sage_trac/attachment/ticket/8699/trac_8699-documentation.patch
trac_8699-documentation.patch]
* [http://trac.sagemath.org/sage_trac/attachment/ticket/8699/trac_8699
-single-quotes.patch trac_8699-single-quotes.patch]
--
Comment:
The two patches on this ticket provide documentation for the doctest
coverage script, in addition to allowing that script to handle docstrings
that are delimited by triple single quotes. Incidentally, using those
patches I found that throughout the whole Sage library, only one method
uses triple single quotes. The method in question is `BubbleSortGraph()`
of the module `sage.graphs.graph_generators.py`. This means that for the
90% doctest coverage goal of Sage 5.0, we have one less method to document
because it's already documented. See the following command line
transcript:
{{{
#!sh
[mv...@sage sage-4.4.alpha0-8699-quotes]$ ./sage -coverageall > coverage-
before.log
[mv...@sage sage-4.4.alpha0-8699-quotes]$ cd local/bin/
[mv...@sage bin]$ hg qimport http://trac.sagemath.org/sage_trac/raw-
attachment/ticket/8699/trac_8699-documentation.patch && hg qpush
adding trac_8699-documentation.patch to series file
applying trac_8699-documentation.patch
now at: trac_8699-documentation.patch
[mv...@sage bin]$ hg qimport http://trac.sagemath.org/sage_trac/raw-
attachment/ticket/8699/trac_8699-single-quotes.patch && hg qpush
adding trac_8699-single-quotes.patch to series file
applying trac_8699-single-quotes.patch
now at: trac_8699-single-quotes.patch
[mv...@sage bin]$ cd ../..
[mv...@sage sage-4.4.alpha0-8699-quotes]$ ./sage -coverageall > coverage-
after.log
[mv...@sage sage-4.4.alpha0-8699-quotes]$ diff -Naur coverage-before.log
coverage-after.log
--- coverage-before.log 2010-04-17 03:37:50.663727239 -0700
+++ coverage-after.log 2010-04-17 03:38:45.181442502 -0700
@@ -381,7 +381,7 @@
geometry/polytope.py: 27% (6 of 22)
geometry/polyhedra.py: 100% (186 of 186)
graphs/graph_bundle.py: 100% (5 of 5)
-graphs/graph_generators.py: 98% (73 of 74)
+graphs/graph_generators.py: 100% (74 of 74)
graphs/planarity.pyx: 100% (1 of 1)
graphs/graph_latex.py: 100% (10 of 10)
graphs/schnyder.py: 100% (8 of 8)
@@ -1185,6 +1185,6 @@
Overall weighted coverage score: 81.6%
Total number of functions: 25377
-We need 852 more function to get to 85% coverage.
-We need 2121 more function to get to 90% coverage.
-We need 3390 more function to get to 95% coverage.
+We need 851 more function to get to 85% coverage.
+We need 2120 more function to get to 90% coverage.
+We need 3388 more function to get to 95% coverage.
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8699#comment:2>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
