#9976: Decorated functions/methods have generic signature in documentation
---------------------------------------------------------------+------------
Reporter: jsrn | Owner:
jsrn
Type: enhancement | Status:
closed
Priority: major | Milestone:
sage-4.7.1
Component: documentation | Resolution:
fixed
Keywords: sphinx, documentation, cython inspection | Work_issues:
Upstream: N/A | Reviewer:
Johan Sebastian Rosenkilde Nielsen, Simon King
Author: Johan Sebastian Rosenkilde Nielsen, Simon King | Merged:
sage-4.7.1.alpha0
Dependencies: |
---------------------------------------------------------------+------------
Description changed by jdemeyer:
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
>
> 1. [attachment:trac_9976_decorated_generic_sigs_alternative.patch]
> 2. [attachment:9976-inspection_of_cython.patch]
> 3. [attachment:9976_doc_fixes.patch]
> 4. [attachment:9976_notebook_doc_fixes.patch]
>
> Note that the last patch belongs to a different repository!
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
1. [attachment:trac_9976_decorated_generic_sigs_alternative.patch]
2. [attachment:9976-inspection_of_cython.patch]
3. [attachment:9976_doc_fixes_v2.patch]
4. [attachment:9976_notebook_doc_fixes.patch]
Note that the last patch belongs to a different repository!
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:178>
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.
