#4916: [with patch, needs review] convert sage.lfunctions.* docstrings to Sphinx
---------------------------+------------------------------------------------
Reporter: mhansen | Owner: tba
Type: enhancement | Status: new
Priority: major | Milestone: sage-3.4
Component: documentation | Resolution:
Keywords: |
---------------------------+------------------------------------------------
Comment (by robertwb):
Just looking at the patch looks mostly good, is this rendered somewhere to
look at?
Also, I noticed significant readability degradation plain text
documentation:
{{{
conductor -- integer, the conductor
48 gammaV -- list of Gamma-factor parameters,
49 e.g. [0] for Riemann zeta, [0,1] for
ell.curves,
50 (see examples).
51 weight -- positive real number, usually an integer
52 e.g. 1 for Riemann zeta, 2 for $H^1$ of
curves/$\Q$
53 eps -- complex number; sign in functional
equation
54 poles -- (default: []) list of points where
$L^*(s)$ has (simple) poles;
55 only poles with Re(s)>weight/2 should be
included
56 residues -- vector of residues of $L^*(s)$ in
those poles
57 or set residues='automatic' (default
value)
58 prec -- integer (default: 53) number of *bits* of
precision
}}}
vs
{{{
50
51 conductor - integer, the conductor gammaV - list of
Gamma-factor
52 parameters, e.g. [0] for Riemann zeta, [0,1] for
ell.curves, (see
53 examples). weight - positive real number, usually an
integer e.g. 1
54 for Riemann zeta, 2 for `H^1` of
55 curves/`\mathbb{Q}` eps - complex number; sign in
56 functional equation poles - (default: []) list of
points where
57 `L^*(s)` has (simple) poles; only poles with
Re(s)weight/2
58 should be included residues - vector of residues of
59 `L^*(s)` in those poles or set residues='automatic'
60 (default value) prec - integer (default: 53) number of
*bits* of
61 precision
}}}
Another note, the EXAMPLES:: seems redundant, would it make sense to
replace EXAMPLES: with EXAMPLES:: (same with TESTS, etc.) Or perhaps all
sage: blocks could automatically be detected (doesn't seem too hard).
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/4916#comment:2>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
