#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
Reporter: jsrn | Owner: jsrn
Type: enhancement | Status: needs_work
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 jsrn):
Replying to [comment:144 SimonKing]:
> Of course that's the reason why it has not been noticed before. It is
something the ''should'' probably be included in the reference, but has
been skipped, because it was not a class but a class instance.
Probably.
>
> Why switching? I have not looked at the code of functools.partial, yet.
But it sounds like providing a _sage_doc_ and _sage_getargspec_ in
functools.partial would suffice for everything else that relies on it.
We can't (or shouldn't) change functools.partial because it's from the
Python standard library. We should make a wrapper and put that somewhere
in sage.misc, I guess?
> It might be acceptable that after our patches there are still some
functions that are not documented as nicely as they should. However, an
''error'' building documentation is certainly not acceptable.
Yeah, I agree. We can't fix all the world's problems in this ticket ;-)
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:145>
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.
