#7683: sphinx reference manual documentation has a *major* issues: in some cases
the input parameters to functions are completely omitted causing great
confusion!
-----------------------------+----------------------------------------------
Reporter: was | Owner: mvngu
Type: defect | Status: new
Priority: critical | Milestone: sage-4.3.1
Component: documentation | Keywords:
Work_issues: | Author:
Upstream: N/A | Reviewer:
Merged: |
-----------------------------+----------------------------------------------
See
http://sagemath.org/doc/reference/sage/rings/integer.html#sage.rings.integer.Integer.jacobi
Notice that the input parameter b is simply totally omitted from the
function signature. In sharp contrast, if you type
{{{
sage: a = 5
sage: a.jacobi(<tab>
}}}
in the notebook, then you'll see the correct sphinx-rendered documentation
*with* the other input argument. This is very bad and confusing for some
users who trust reference manuals, especially because evidently the use of
INPUT/OUTPUT blocks to describe parameters of functions is not being used
nearly as much as it should be (there will be another ticket about that).
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/7683>
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.
