#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):
There is a lot on this ticket, and I haven't read most of it. But here is
one comment nonetheless: suppose I have this in a Sage library file:
{{{
from sage.misc.cachefunc import CachedFunction
def test1():
"This is a docstring for test1"
pass
test2 = CachedFunction(test1)
@CachedFunction
def test3():
"This is a docstring for test3"
pass
}}}
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 (as is
test2, but I don't consider that as important). This means that if you
have a really important function that you want to cache, it seems as
though you need to attach two names to it, a non-cached version for the
reference manual and then a cached version for actual use. Is that right?
Is there any way around it? Or am I doing something wrong?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:127>
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.
