#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-4.7.2
Component: doctest | Keywords:
Work_issues: | Upstream: N/A
Reviewer: | Author: John Palmieri
Merged: | Dependencies:
---------------------------+------------------------------------------------
Changes (by jhpalmieri):
* status: new => needs_review
Old description:
> Marking a doctest `# known bug` means that it is skipped unless the
> `--optional` flag is passed to `sage -t`. This needs to be documented.
>
> Also, many doctests in Sage are marked `# optional - requires PKG`, and
> this means that `sage -t -only-optional=PKG ...` does not run the test:
> the word "requires" is interpreted as a package name. This is not ideal.
>
> The attached patch to the scripts repo removes the word "requires" (and
> also "needs") automatically. It also allows a colon or comma instead of
> a hyphen, as in `# optional: requires PKG`. It also converts tests
> marked as "known bug" to tests marked as "optional bug", so they are run
> when you do `sage -t -only-optional=bug ...`. The attached patch to the
> main Sage library documents all of this.
>
> -------
>
> Apply
New description:
Marking a doctest `# known bug` means that it is skipped unless the
`--optional` flag is passed to `sage -t`. This needs to be documented.
Also, many doctests in Sage are marked `# optional - requires PKG`, and
this means that `sage -t -only-optional=PKG ...` does not run the test:
the word "requires" is interpreted as a package name. This is not ideal.
The attached patch to the scripts repo removes the word "requires" (and
also "needs") automatically. It also allows a colon or comma instead of a
hyphen, as in `# optional: requires PKG`. It also converts tests marked
as "known bug" to tests marked as "optional bug", so they are run when you
do `sage -t -only-optional=bug ...`. The attached patch to the main Sage
library documents all of this.
-------
Apply
- [attachment:trac_11615-scripts-repo.patch] to the scripts repo
- [attachment:trac_11615-document-known-bug.patch] to the main Sage
library repo
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11615#comment:1>
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.
