#10461: Raising doctest coverage to 100% for sage/combinat/partition.py
---------------------------------------+------------------------------------
Reporter: abmasse | Owner: mvngu
Type: enhancement | Status: needs_info
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 abmasse):
* status: needs_work => needs_info
Comment:
Replying to [comment:3 cremona]:
> The latter can be fixed by inserting the tag # indirect doctest on the
relevant lines.
Ok, thanks, I will correct those!
>
> 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.
Ok for the mathematical markup.
About the INPUT and OUTPUT blocks, do I have to put them for every
function? I didn't know that. By the way, it seems that in #9228, the
docstring you added do not contain those INPUT/OUTPUT blocks? Is it
because I don't understand you or because we have to put them only in some
cases?
>
> The reference manual rebuilds fine, no warnings.
>
> Hence: needs work (but only trivial work).
>
> Feel free to return the compliment at #9228!
I'll give it a shot. Thank you for the review!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/10461#comment:4>
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.
