#20601: Issue @experimental warnings only once
-------------------------------------+-------------------------------------
Reporter: jsrn | Owner:
Type: defect | Status: needs_review
Priority: major | Milestone: sage-7.3
Component: misc | Resolution:
Keywords: warnings, | Merged in:
experimental | Reviewers:
Authors: Johan S. R. | Work issues:
Nielsen | Commit:
Report Upstream: N/A | 5c288220006c7d1edd93594b0b20ac6dbedfe6eb
Branch: | Stopgaps:
u/jsrn/20601_experimental |
Dependencies: |
-------------------------------------+-------------------------------------
Comment (by jsrn):
I managed to make a test that properly demonstrates the behaviour: without
the patch, the test fails since extra `FutureWarning`s are issued, while
the test passes with the patch.
Due to aforementioned Sphinx magic the test is a bit complicated: it seems
the test has to involve a "real" function/class and span multiple
documentation strings, so I've added a class `__experimental_self_test`
for this purpose.
Note that this behaviour is really critical, i.e. that only a single
warning is issued across documentation strings: if not, a class that is
marked as `@experimental` would need to add the `FutureWarning` to *all*
documentation strings in the entire file. With this patch, only a single
at the top needs to be added (e.g. together with the documentation text
that describes that the functionality is experimental).
The patch is still in needs review.
--
Ticket URL: <http://trac.sagemath.org/ticket/20601#comment:5>
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 unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at https://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
