#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
Reporter: jsrn | Owner: mvngu
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:35 SimonKing]:
> Replying to [comment:34 SimonKing]:
> > * I'll remove the "except TypeError" from sage_autodoc.py, since it
is caught in sageinspect.py anyway.
>
> Probably better not. According to the comments in sage_autodoc.py, the
reason for catching `TypeError` is something that is not taken care of in
`sage_getargspec`, and it handles these cases using
`self.env.config.autodoc_builtin_argspec`, which is something
`sageinspect.py` doesn't know of.
No, the TypeError is around the try which is after the logic possibly
calling the builtin_argspec-thing: It first checks for a _sage_getarspec-
attribute, then it checks if it is a builtin (in which case it uses the
builtin_argspec), and if both fail, it tries to use inspect.getargspec
(after your patch, sageinspect.sage_getargspec). Now, inspect.getargspec
may throw a TypeError if the argument is class and this is then handled
separately. But you already do than in sageinspec.sage_getarspec, right?
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:37>
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.
