#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
Reporter: jsrn | Owner: jsrn
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: Simon King | Merged:
Work_issues: |
--------------------------------+-------------------------------------------
Comment(by jhpalmieri):
Replying to [comment:129 SimonKing]:
> Replying to [comment:127 jhpalmieri]:
> > Then if I import everything from this file, from the "sage:" prompt, I
get the right docstrings for the right functions. Great! On the other
hand, the function test3 is completely missing from the reference manual
>
> Why do you think test3 is missing?
It's missing '''from the reference manual''': I put this code at the
bottom of sage/misc/latex.py (just to pick a file at random from among
those included in the reference manual), ran "sage -b", and rebuilt the
documentation. The manual had test1 in it, but not test3. I feel like
this is a serious problem with decorated functions (or at least cached
functions) and the reference manual: we shouldn't have to sacrifice
quality and completeness of documentation to get better performance by
caching things.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:130>
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.
