#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 jsrn):
Replying to [comment:23 SimonKing]:
> Replying to [comment:22 jsrn]:
> >
> > It seems to be from a call to _sage_getdoc_unformatted in
sageinspect.py on an object which does not support it.
>
> Snap diagnose: That class raises a `KeyError` when it should raise an
`AttributeError`.
>
> Two ways of fixing:
>
> 1. Replace the `raise KeyError("no colormap with name '%s'"%name)` by
an `AttributeError`.
> 2. In `_sage_getdoc_unformatted`, catch not only `AttributeError`s but
also `KeyError`s.
>
> Can you find out whether raising the `KeyError` is new in
sage-4.7.alpha3, and what ticket is to blame?
>
> Cheers,
> Simon
The ticket is #5601 and more than a year old, but the KeyError might have
been introduced even before. However, KeyError is clearly the wrong
exception: according to Python documentation, it should be used for
dictionaries (and derivatives) when asking for a non-present key. As you
point out, it should be AttributeError. So I see two possibilities:
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
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:26>
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.
