#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
Reporter: jsrn | Owner: mvngu
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: | Merged:
Work_issues: |
--------------------------------+-------------------------------------------
Changes (by SimonKing):
* status: needs_work => needs_review
Old description:
> Functions or methods that have been decorated by generic decorators such
> as sage.misc.decorators.options (moved from sage.misc.plot.options with
> Trac #9907) degrade documentation by reducing the signature for these
> callables to the generic "(*args, **kwargs)".
>
> See also the following sage.devel discussion:
> http://groups.google.com/group/sage-
> devel/browse_thread/thread/cbd888f0e60130ff/f533792113c45c2f
>
> Let's say that the advanced patch is the most useful and scalable. So
> ignore the first one and:
>
> Apply 9976_change_to_argspec.patch
> trac_9976_decorated_generic_sigs_alternative.patch
> 9976-inspection_of_cython.patch
New description:
Functions or methods that have been decorated by generic decorators such
as sage.misc.decorators.options (moved from sage.misc.plot.options with
Trac #9907) degrade documentation by reducing the signature for these
callables to the generic "(*args, **kwargs)".
See also the following sage.devel discussion:
http://groups.google.com/group/sage-
devel/browse_thread/thread/cbd888f0e60130ff/f533792113c45c2f
Let's say that the advanced patch is the most useful and scalable. So
ignore the first one and:
Apply trac_9976_decorated_generic_sigs_alternative.patch
inspection_of_cython.patch
--
Comment:
Since [attachment:9976_change_to_argspec.patch] does not do the necessary
changes in sage/structure/element.pyx and in sage/misc/lazy_import.pyx, it
is hopefully OK that I suggest to replace it with the patch that I just
updated.
That patch also contains the fix for plots: An `AttributeError` is raised,
not a `KeyError` (and it is tested, of course).
Since your patches changed, I am afraid I need to run long tests again.
But I am fairly confident, and so I change the status into "needs review".
For the patchbot:
Apply trac_9976_decorated_generic_sigs_alternative.patch
inspection_of_cython.patch
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:52>
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.
