#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
Reporter: jsrn | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.7
Component: documentation | Keywords: sphinx, documentation, cython
inspection
Author: jsrn, Simon King | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
--------------------------------+-------------------------------------------
Comment(by SimonKing):
Replying to [comment:55 jsrn]:
> I'll do the change. But a new doc-test showing which error? In
plot.colors? That would be superfluous, right?
Thank you!
I thought that the `__getattr__` method in plot.colors should get a test,
demonstrating that the correct error is raised. Of course, getting the
correct error is also tested somewhere else, but in general I believe that
a bug fix should be tested in the method that was fixed.
Good and bad news:
The good news is that the long tests all pass.
The bad new is that I get 80 warnings when building the documentation.
Typically, it is
{{{
.../doc/en/reference/sage/rings/polynomial/real_roots.rst:7: (WARNING/2)
error while formatting signature for
sage.rings.polynomial.real_roots.bernstein_polynomial_factory_ratlist.coeffs_bitsize:
arg is not a code object
}}}
and I also obtain
{{{
WARNING: display latex u'\\R': latex exited with error:
[stderr]
...
! Undefined control sequence.
<recently read> \R
l.29 $\R
$
[1] (./math.aux) )
(see the transcript file for additional information)
Output written on math.dvi (1 page, 152 bytes).
Transcript written on math.log.
WARNING: display latex u'\\R^+': latex exited with error:
[stderr]
[stdout]
}}}
Do you have an idea what happened there?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:56>
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.
