More documentation #114
Closed
More documentation #114
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.
added 10 commits
December 27, 2016 16:38
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.
ghost
requested review from
chaosphere2112
suggested changes
Jan 10, 2017
Fixes some links. Adds documentation for dv3d (from documentation site). changes some xmldocs strings to use .format().
ghost
pushed a commit
to CDAT/cdat
that referenced
this pull request
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.
ghost
mentioned this pull request
added 5 commits
January 11, 2017 12:52
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.
aashish24
reviewed
Jan 12, 2017
| @@ -0,0 +1,307 @@ | |||
| Canvas | |||
There was a problem hiding this comment.
@embrown is htis automatically generated or did you have to manually create this one?
There was a problem hiding this comment.
@aashish24 I have a script in docs/API that builds this out. It checks all of VCS's modules using the inspect library, and prints out an RST-formatted link to the appropriate file (https://github.com/embrown/vcs/blob/more_more_documentation/docs/API/build_func_index.py).
|
@doutriaux1 @embrown I'm migrating this over to a new pull request. I added one more commit, and I think we're good to go. Since @doutriaux1 is migrating the testsuite in #127, we can skip the matching UV-CDAT PR CDAT/cdat#2151 and just integrate it once we've moved over to a full |
Merged
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.
There's a lot in this one!