Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds doctesting to the VCS test suite. #2151

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

ghost
Copy link

@ghost ghost commented Jan 11, 2017

Currently only queries test is implemented.
Once CDAT/vcs#114 is merged, this test
will pass. Tests for other modules/classes will be very similar.

Already did some setup for running with vcs.Canvas. A few of the
steps in this script aren't necessary for queries, but will be
needed for others (the cleanup step is mainly for Canvas and
manageElements).

If docstring contains '.. pragma: skip-doctest', the doctest
for that docstring will not be run.
If docstring is empty and not private, and has not been skipped,
it will be printed in a "NO DOCUMENTATION" list after the tests
so we can view it on cdash, but it will not cause a failure.

Currently only queries test is implemented.
Once CDAT/vcs#114 is merged, this test
will pass. Tests for other modules/classes will be very similar.

Already did some setup for running with vcs.Canvas. A few of the
steps in this script aren't necessary for queries, but will be
needed for others (the cleanup step is mainly for Canvas and
manageElements).

If docstring contains '.. pragma: skip-doctest', the doctest
for that docstring will not be run.
If docstring is empty and not private, and has not been skipped,
it will be printed in a "NO DOCUMENTATION" list after the tests
so we can view it on cdash, but it will not cause a failure.
@ghost ghost requested a review from chaosphere2112 January 11, 2017 19:47
* Canvas.py
* boxfill.py
* colormap.py
* displayplot.py
* fillarea.py
* isofill.py
* isoline.py
* line.py
* manageElements.py
* marker.py
* meshfill.py
* projection.py
* taylordiagram.py
* template.py
* textcombined.py
* textorientation.py
* texttable.py
@ghost
Copy link
Author

ghost commented Jan 12, 2017

@doutriaux1 @chaosphere2112 I got the bulk of the modules/classes in VCS.

Tests that break:

  • meshfill
  • isofill
  • textcombined
  • texttable

Every test will break until CDAT/vcs#114 is merged. The above tests, and some tests I have not added yet, will break until #2144 and CDAT/vcs#104 are merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant