#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
Reporter: jsrn | Owner: mvngu
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: | Merged:
Work_issues: |
--------------------------------+-------------------------------------------
Comment(by SimonKing):
Replying to [comment:26 jsrn]:
> 1) Open a new ticket for fixing this and let this ticket depend on it,
not changing this patch.
> 2) Change this patch to allow KeyError but open a new ticket changing
KeyError to AttributeError and adding a note that the catch for KeyError
we just added should be removed in the new ticket's patch.
>
> The second possibility is in case it for some reason becomes a problem
changing the KeyError; a lot of code might (for sick reasons) depend on
color throwing a KeyError :-S
Both solutions involve opening a new ticket. So, that should be done
anyway. Can you do it?
I already sketched a patch for the new ticket. If doc tests pass after
changing the `KeyError` into an `AttributeError` (and of course if there
is an additional doc test verifying the correct error type) then it can
certainly be given a positive review and made a dependency for this ticket
(hence, solution 1). Otherwise, we go for solution 2).
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:30>
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.
