#11615: optional doctests: clean up and document "known bug", "optional:
requires
PKG"
---------------------------------+------------------------------------------
Reporter: jhpalmieri | Owner: mvngu
Type: enhancement | Status: needs_review
Priority: minor | Milestone: sage-5.0
Component: doctest | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers: Karl-Dieter Crisman
Authors: John Palmieri | Merged in:
Dependencies: | Stopgaps:
---------------------------------+------------------------------------------
Comment (by jhpalmieri):
Here is a new documentation patch, which just makes the following change:
{{{
#!diff
diff --git a/doc/en/developer/conventions.rst
b/doc/en/developer/conventions.rst
--- a/doc/en/developer/conventions.rst
+++ b/doc/en/developer/conventions.rst
@@ -880,7 +880,7 @@ mind:
Then the doctest will be skipped by default, but could be revealed
by running ``sage -t --only-optional=bug ...``. (A doctest marked
as ``known bug`` gets automatically converted to ``optional bug``,
- so it is also detected by ``--only-optional=bug``.)
+ so it is also detected by ``--optional`` or ``--only-optional=bug``.)
- If the entire documentation string contains all three words
``optional``, ``package``, and ``installed``, then the entire
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11615#comment:9>
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.
