#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 jsrn):
Replying to [comment:65 SimonKing]:
> Replying to [comment:64 jsrn]:
> > No, groebner_basis has never worked with my patch; for my patch to
work, it requires that the decorator use @sage_wraps on the wrapping
function which is returned.
>
> Did you check whether it works with my latest patches? With them,
`sage_getargspec` works on `groebner_basis()`.
I was being unclear before; what I meant to say was that a decorator
should usually just use sage_wraps and then not worry any more about all
this inheriting of __doc__, etc. However, another route is to do it
manually as cached_method does.
However, it doesn't seem to work for me. I still get some warnings (in
sage.rings.padics.padic_ZZ_pX_CA_element,
sage.rings.padics.padic_capped_relative_element,
sage.rings.polynomial.multi_polynomial_ring_generic), and then a latex
error like the ones you described earlier. I wasn't supposed to apply your
11115 patch, was I?
>
> In fact, I just checked that the documentation looks ok if I apply both
our patches.
>
> By the way, I asked at [sage-devel http://groups.google.com/group/sage-
devel/browse_thread/thread/dd7de9c504c13164] whether it is ok if I review
your patch and you review mine.
Sounds good; I was thinking the same thing.
> I think that would be a waste of time. The to-be-submitted Cython
version of @cached_method will be ''vastly'' superior to the old Python
version, but you can't use a decorator such as @sage_wraps in Cython code.
Moreover, if I am not mistaken, the problem is already solved with our
patches.
Convinced; I hadn't really looked into the extend of your changes in
cached_method. Good job.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:67>
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.
