#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 SimonKing):
Replying to [comment:133 jhpalmieri]:
> 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?
On the one hand, the original purpose of this ticket was to fix the
signature of decorated functions and methods - which means it does not
belong here. On the other hand, it does say "signature of decorated
''functions''/methods". So, if cached functions are not included in the
references then it does belong here.
My snap diagnose is that the documentation builder skips class instances,
unless they are members of another class. Hence, cached methods are
documented, but cached functions aren't. By the way, it is no surprise
that nobody complained about it, before, since @cached_method is hardly
used, yet. Certainly not as frequently as cached methods.
If it is easy to fix, I think we should try it here.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:135>
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.
