#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
Author: jsrn | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Comment(by SimonKing):
How is the documentation of a class, method etc. actually obtained? There
is a method `get_doc` in sage_autodoc.py, but it was not called when I
expected it.
Could it by the the work is done by the method `find_attr_docs()` of
`sphinx.pycode.ModuleAnalyzer`? That would be bad, because certainly it is
ignorant to methods such as `_sage_doc_()`!
By consequence, if one has a method that is decorated by a cython class
(something that I plan for the cached_method decorator) then the
documentation will be that of the cython class, not that of the decorated
method.
So, could it be that we have to replace `sphinx.pycode.ModuleAnalyzer`?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:15>
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.
