#8799: Bring doctests for mwrank.pyx up to 100% (from 3%)
-----------------------------------------------+----------------------------
Reporter: cremona | Owner: mvngu
Type: defect | Status: needs_review
Priority: major | Milestone: sage-5.0
Component: documentation | Keywords: mwrank
Author: John Cremona | Upstream: N/A
Reviewer: Minh Van Nguyen, Leif Leonhardy | Merged:
Work_issues: |
-----------------------------------------------+----------------------------
Changes (by mvngu):
* reviewer: => Minh Van Nguyen, Leif Leonhardy
Old description:
> Improve documentation for this:
> {{{
> sage/libs/mwrank/mwrank.pyx: 3% (1 of 30)
> }}}
New description:
Improve documentation for this:
{{{
sage/libs/mwrank/mwrank.pyx: 3% (1 of 30)
}}}
Apply in this order:
1. [http://trac.sagemath.org/sage_trac/attachment/ticket/8799/trac_8799
-mwrank-doctest.patch trac_8799-mwrank-doctest.patch]
1. [http://trac.sagemath.org/sage_trac/attachment/ticket/8799/trac_8799
-reviewer-total.patch trac_8799-reviewer-total.patch]
--
Comment:
I have made some more changes to the docstring of `interface.py` and
`mwrank.pyx`. My second reviewer patch
[http://trac.sagemath.org/sage_trac/attachment/ticket/8799/trac_8799
-reviewer-part3.patch trac_8799-reviewer-part3.patch] includes changes in
addition to the original reviewer patch and leif's patch. With many
patches to apply, it can be confusing to see what changes the reviewers
propose. So I have folded the reviewers' patches into one mega patch
called
[http://trac.sagemath.org/sage_trac/attachment/ticket/8799/trac_8799
-reviewer-total.patch trac_8799-reviewer-total.patch].
[[BR]]
Also notice that I move documentation for constructor methods, i.e.
`__init__`, into the docstring of a class. The main reason is that,
currently the docstring of `__init__` don't show up on the reference
manual once you built it.
[[BR]]
To rebuild the whole reference manual, you could do the following from
`SAGE_ROOT`, assuming you applied the patches to the branch main:
{{{
#!sh
./sage -b main
./sage -docbuild reference html
}}}
If you want to be thorough and want to check that the new documentation
build OK, do:
{{{
#!sh
rm -rf devel/sage-main/doc/output/
./sage -b main
./sage -docbuild reference html
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8799#comment:15>
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.
