#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: |
--------------------------------+-------------------------------------------
Comment(by jsrn):
Replying to [comment:52 SimonKing]:
> 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.
Sure. The double work was unfortunate -- would have been nice with a more
direct communication channel to avoid this.
>
> That patch also contains the fix for plots: An `AttributeError` is
raised, not a `KeyError` (and it is tested, of course).
I also did that, so more double work. My patch was slightly different: I
added doc-tests demonstrating the different exception class with different
access methods (maps.punk vs maps['punk']). I also used
self.__class__.__name__ instead of type(self) for the output string. I
don't particularly feel strongly for either, though.
>
> 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".
Yup, me too; and compile all documentation again :-S But at long last we
seem to be right about there...
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:53>
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.
