#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 SimonKing):
Replying to [comment:160 jsrn]:
> Ok, in this case I think it actually would be best to always return the
argspec of the underlying function.
Right, let's do so. I'll update my patch accordingly.
> What I meant is to produce a warning in sage_autodoc or
sageinspect.sage_* if we come upon a function with this behaviour -- but
only on the module-level which is to be documented.
>
> ...
> Of course, we should never introduce such things without consulting
sage-devel first.
Sure. And I think that introducing such warning should ''really'' be a
different ticket. This here is already fat enough.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:161>
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.
