#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):
Before sleeping, a last data point: I've put your example into a file
testmod.py. Even without our patches, one gets:
{{{
sage: import testmod
sage: dir(testmod)
['CachedFunction', '__builtins__', '__doc__', '__file__', '__name__',
'__package__', 'test1', 'test2', 'test3']
}}}
AFAIK, the reference builder searches the members of a module, and thus
should certainly include test1, test2 and test3.
Hm. Unless it skips class instances, which could very well be. If this was
the case then (at least) we are not to blame for it, since it was like
that before.
I already have a potential solution (should it be the case that class
instances are not included into the references): It should be reasonable
to include a class instance if its documentation is different from the
documentation of its class.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:134>
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.
