#10461: Raising doctest coverage to 100% for sage/combinat/partition.py
---------------------------------------+------------------------------------
Reporter: abmasse | Owner: mvngu
Type: enhancement | Status: needs_work
Priority: minor | Milestone: sage-4.6.2
Component: documentation | Keywords:
Author: Alexandre Blondin Massé | Upstream: N/A
Reviewer: John Cremona | Merged:
Work_issues: |
---------------------------------------+------------------------------------
Changes (by cremona):
* status: needs_review => needs_work
* reviewer: => John Cremona
Comment:
Review: patch applies fine to 4.6.1.alpha3, and tests in
sage.combinat.partition pass.
After the patch:
{{{
sage/combinat/partition.py
SCORE sage/combinat/partition.py: 100% (155 of 155)
Possibly wrong (function name doesn't occur in doctests):
* from_exp(exp):
* from_core_and_quotient(core, quotient):
* _repr_(self):
* _repr_(self):
* partition_sign(pi):
}}}
The latter can be fixed by inserting the tag # indirect doctest on the
relevant lines.
In addition: The new docstrings do not conform to Sage's standards
perfectly. Each function should have a one line description, then INPUT
and OUTPUT blocks to describe the input parameters (if any; ignore self)
and output. And apply suitable markup to mathematical symbols: a few are
missing.
The reference manual rebuilds fine, no warnings.
Hence: needs work (but only trivial work).
Feel free to return the compliment at #9228!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10461#comment:3>
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.
