Doctest cleanup #131
Merged
Doctest cleanup #131
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Re-wrote to change ._name and pop old name from elements if not 'default'. Preserves original objects.
Fixing doctest errors where applicable. General documentation formatting fixes.
Ran doctests and updated logs.
Removed some modules from run_all_doctests.sh . Fixed xmldocs so it doesn't try to plot projections/templates. Started dv3d descriptions.
Minor fixes in Canvas, colormap, and xmldocs.
section of the log.
Make html now reports (almost) no errors. Re-ran doctests/logging.
Added more template documentation. Working on documentation in various stages for other files.
Re-ran doctests and re-reported.
parsing report output with doctest.py. Regular expressions can be added via commandline or ignore file. This will allow us to ignore 'missing' doctests for functions that don't need documentation, or for aspects of a module/class which are not functions that errantly get picked up by doctest.testmod.
Added docs/API/build_func_index.py to automatically check a list of modules/classes, get their non-private functions, and write the RST for linking to those functions in the documentation out to API/functions/$MODULE_NAME to create the functions index. Not all functions written out to the /rst files have been documented.
what's in them and how to use it. Added an ignore directory to store files for using doctest_vcs.py's --ifile option.
in pdf. Re-ran doctest_vcs.py to check functionality after some minor edits.
Fixes some links. Adds documentation for dv3d (from documentation site). changes some xmldocs strings to use .format().
needed for vcs's test suite. Updated output for 3d graphics methods to match VCS's output. These will need to be changed after CDAT/dv3d#14 is resolved.
|
@chaosphere2112 should I wait for the test suite to be completed to merge this in? |
|
@chaosphere2112 @doutriaux1, does this mean that the doctests are integrated into the vcs test suite and actually working to validate example code? |
|
almost see #132 |
aashish24
pushed a commit
that referenced
this pull request
Feb 28, 2017
* Fixes #2, Gfb.rename(). Re-wrote to change ._name and pop old name from elements if not 'default'. Preserves original objects. * Working on vcs documentation again. * Trying to fix doctest strings * Trying to get testing to work * Fixing errors for tests * Working on a script to parse doctest output for error warnings * Running individual modules through doctest and processing output * Working on doctest_vcs.py * Working on doctest scripts * Working on improving doctest reporting * Added README.md with links to doctest logs * Fixed README to be markdown friendly * Fixed errors in manageElements. Added doctests. General formatting improvements. * Adding doctests where they are missing. Fixing doctest errors where applicable. General documentation formatting fixes. * Adding doctests/documentation where necessary. Ran doctests and updated logs. * Fixing/adding doctests * Added more examples/doctests to utils.py . Removed some modules from run_all_doctests.sh . Fixed xmldocs so it doesn't try to plot projections/templates. Started dv3d descriptions. * Tweaked doctest cleanup. Fixed manageElements doctests. * Organized doctest_info directory. Minor fixes in Canvas, colormap, and xmldocs. * Fixed reference to old branch in README.md * Docstring formatting. Doctest corrections. Changed Not Yet Implemented warning. * doctest_vcs.py now filters out private functions from the missing section of the log. * Fixed more docstring formatting issues. Make html now reports (almost) no errors. Re-ran doctests/logging. * Fixing up template. Deleted old file in scripts/ * Undocumented some internal functions to template. Added more template documentation. Working on documentation in various stages for other files. * Updating logs. * Fixed taylordiagram examples * Added example to mtics doc * Adding doctests to xmldocs: * Fixed doctests for ticlabels, exts * Refactored doctest_vcs.py and re-ran tests. * Working on extracting repetetive params to xmldocs. * Re-factored xmldocs formatting. Re-ran doctests and re-reported. * Added functionality to ignore certain regular expressions when parsing report output with doctest.py. Regular expressions can be added via commandline or ignore file. This will allow us to ignore 'missing' doctests for functions that don't need documentation, or for aspects of a module/class which are not functions that errantly get picked up by doctest.testmod. * Added an Index of VCS functions for the pdf output. Added docs/API/build_func_index.py to automatically check a list of modules/classes, get their non-private functions, and write the RST for linking to those functions in the documentation out to API/functions/$MODULE_NAME to create the functions index. Not all functions written out to the /rst files have been documented. * Added README.md to doctest_info directories briefly explaining what's in them and how to use it. Added an ignore directory to store files for using doctest_vcs.py's --ifile option. * Formatted :Example: sections to <=80 lines so they look better in pdf. Re-ran doctest_vcs.py to check functionality after some minor edits. * Removed Makefile call to old function * Adds doctest_info/ to .gitignore. Fixes some links. Adds documentation for dv3d (from documentation site). changes some xmldocs strings to use .format(). * Added '.. pragma: skip-doctest' statements in some places they are needed for vcs's test suite. Updated output for 3d graphics methods to match VCS's output. These will need to be changed after CDAT/dv3d#14 is resolved. * Added lots of '.. pragma: skip-doctest' and fixed some broken tests. * Added skip-doctest to some docstrings. * Standardized print statements for .list() * Added things to stop tests from breaking * Removed some unused files, fixed one context-dependent doctest
This was referenced Mar 1, 2017
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Continues @embrown's #114, should be good-to-go.