#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
Reporter: jsrn | Owner: jsrn
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: Simon King | Merged:
Work_issues: |
--------------------------------+-------------------------------------------
Changes (by SimonKing):
* status: needs_work => needs_review
* work_issues: Cosmetical changes, indirect doctests =>
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 trac_9976_decorated_generic_sigs_alternative.patch
> 9976-inspection_of_cython.patch 9976_doc_fixes.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
9976-inspection_of_cython.patch 9976_doc_fixes.patch
9976_notebook_doc_fixes.patch
Note that the last patch belongs to a different repository!
--
Comment:
I updated my patch.
In fact I had to add another patch: It belongs to the devel/sagenb
repository. So, be careful where you apply it!
Concerning the indirect doctests: Meanhile I think that you are right.
There is no class method `_sage_argspec_`, and hence no documentation for
it. So, an indirect test makes no sense.
I am now running long doctests (based on sage-4.7.alpha5). If they pass
then I can give your patch a positive review. I hope that you will cross-
verify the syntax fixes in the documentation.
Apply trac_9976_decorated_generic_sigs_alternative.patch
9976-inspection_of_cython.patch 9976_doc_fixes.patch
9976_notebook_doc_fixes.patch
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:124>
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.
