#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:143 jsrn]:
> When building the reference manual now, sage.combinat.partition_algebra
fails explosively.
> ...
> I don't know exactly what part of the patch caused this error to be seen
now and not earlier (looking at
http://sagemath.org/doc/reference/sage/combinat/partition_algebra.html, we
can see that before the patch, the offensive elements of the module
(e.g.SetPartitionsAk) were simply not included in the reference manual)
Of course that's the reason why it has not been noticed before. It is
something the ''should'' probably be included in the reference, but has
been skipped, because it was not a class but a class instance.
> 2) Write a wrapper/alternative version of functools.partial which
properly sets _sage_doc_ and _sage_getargspec_ etc. such that this
shouldn't happen. This might entail switching to this partial function
instead of functools.partial in other places of Sage than just
partition_algebra.
Why switching? I have not looked at the code of functools.partial, yet.
But it sounds like providing a _sage_doc_ and _sage_getargspec_ in
functools.partial would suffice for everything else that relies on it.
> 1) should be easiest and perhaps is a good idea in any circumstance
(owing to the discussion earlier on whether to service everything or
service only well-formed callables). 2) should take some more effort and
might be another ticket.
It might be acceptable that after our patches there are still some
functions that are not documented as nicely as they should. However, an
''error'' building documentation is certainly not acceptable.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:144>
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.
