#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:131 SimonKing]:
> Replying to [comment:128 jhpalmieri]:
> > Or is this issue with cached functions dealt with by #11115?
>
> As I have demonstrated in my preceding post, documentation has not been
an issue for cached functions or methods.
I think you and I are using the word "documentation" differently. I would
say that "introspection" has not been an issue for cached functions or
methods, at least if I understand you correctly. But the autodoc feature
of the Sphinx-built reference manual doesn't seem to work properly with
cached functions; I don't think it ever has. So there is an issue. Maybe
it doesn't belong on this ticket, but I was hoping you were dealing with
it here. If it doesn't belong here, do you have any ideas how to fix it?
> Perhaps you confuse the purpose of the two tickets: Here, we have the
purpose of getting the documentation of cached methods right, which also
involves to broaden the capability of sage.misc.sageinspect -- it is not
about performance at all. #11115 is about performance, but it should
certainly not affect the documentation.
I was using "performance" to refer to the purpose behind cached functions
in general, not just #11115. You should cache results from a function to
speed it up, right?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:133>
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.
