#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: | Merged:
Work_issues: |
--------------------------------+-------------------------------------------
Comment(by jsrn):
Replying to [comment:101 SimonKing]:
> Even with the correct extraction of the head of a function's definition,
`_sage_getargspec_from_ast` would not correctly parse some more difficult
cases.
>
> At some point, I think we have to accept that `sage_getargspec` can't
solve all problems.
Wow, you really worked on this. But the incorrect parsing thing was
exactly my problem. And the above point hits exactly: you can have an
arbitrary expression in the default argument assignment, so you need to
parse an arbitrary Python (Sage) expression for it to correctly determine
the ending parenthesis in all cases -- and short of calling the correct
method deep inside IPython or something, this should be avoided! As I
mentioned in the beginning, this is probably nitpicking and not very
realistic, though one __could__ try to catch "argument weirdness" and give
an appropriate error message.
Perhaps a wholly different approach in the given case should be
considered; I will think about that later today. For now, I have some work
to do (which I should have done yesterday ;-) )
Cheers
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:102>
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.
