#9330: Documentation for sha_tate.py not quite looking right
-----------------------------------+----------------------------------------
Reporter: kcrisman | Owner: cremona
Type: defect | Status: needs_work
Priority: minor | Milestone: sage-4.5.2
Component: elliptic curves | Keywords:
Author: Chris Wuthrich | Upstream: N/A
Reviewer: Karl-Dieter Crisman | Merged:
Work_issues: |
-----------------------------------+----------------------------------------
Changes (by newvalueoldvalue):
* status: needs_review => needs_work
* reviewer: => Karl-Dieter Crisman
* author: Wuthrich => Chris Wuthrich
Old description:
> When you look at
> [http://www.sagemath.org/doc/reference/sage/schemes/elliptic_curves/sha_tate.html
> this], there are a number of things wrong or confusing in the
> documentation.
>
> Most importantly, several instances of Sha should have ticks, probably.
> But are they referring to the mathematical object
> {{{
> `Sha`
> }}}
> or the computer structure of the class
> {{{
> ``Sha``
> }}}
> ? If I knew what was intended (given that the distinction is quite
> small), I would do this patch myself. But it looks like sometimes the
> group is intended, other times the class object.
>
> In line 198,
> {{{
> You can increase the `descent_second_limit` (in the above example
> }}}
> should have double ticks.
>
> We also get the following warning:
> {{{
> sage-4.4.4/local/lib/python2.6/site-
> packages/sage/schemes/elliptic_curves/sha_tate.py:docstring of
> sage.schemes.elliptic_curves.sha_tate.Sha.bound_kato:12: (WARNING/2)
> Definition list ends without a blank line; unexpected unindent.
> }}}
> this probably refers to
> {{{
> THEOREM (Kato): Suppose `L(E,1) \neq 0` and `p \neq 2, 3` is a
> prime such that
> - `E` does not have additive reduction at `p`,
> - the mod-`p` representation is surjective.
> Then `{ord}_p(\#Sha(E))` divides
> `{ord}_p(L(E,1)\cdot\#E(\QQ)_{tor}^2/(\Omega_E \cdot \prod c_q))`.
> }}}
> but I'm not sure.
>
> In line 756 we have
> {{{
> We get no information the curve has rank 2.::
> }}}
New description:
When you look at
[http://www.sagemath.org/doc/reference/sage/schemes/elliptic_curves/sha_tate.html
this], there are a number of things wrong or confusing in the
documentation.
Most importantly, several instances of Sha should have ticks, probably.
But are they referring to the mathematical object
{{{
`Sha`
}}}
or the computer structure of the class
{{{
``Sha``
}}}
? If I knew what was intended (given that the distinction is quite
small), I would do this patch myself. But it looks like sometimes the
group is intended, other times the class object.
In line 198,
{{{
You can increase the `descent_second_limit` (in the above example
}}}
should have double ticks.
In line 756 we have
{{{
We get no information the curve has rank 2.::
}}}
--
Comment:
There are a few other things in the Description which need to be taken
care of; in the first case, it's to add double ticks, and in the second
it's (probably) to add the word 'when'.
I removed the issue from #9442 from the Description since that is already
merged in rc0 - one will probably have to rebase (very slightly) against
4.5.2.rc0 or 4.5.2, since that has been merged. Once that's done (and
once I build one of those) I'll also check whether it looks right, but
from a cursory glance this looks like a great improvement (and in
consistency!). Or jhpalmieri can do it :)
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9330#comment:5>
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.
