Documentation #7
Merged
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
added 5 commits
September 29, 2016 15:59
…compatible. Most of the docstrings are in RST format, and many have :Example: sections with doctests meant to show usage examples for the code. This is just the beginning phase of updating the documentation. What needs to happen next is that someone familiar with the library and its functions (parameters, return values, etc.) needs to fill in missing param/type and return/rtype. The :Examples: need to be edited such that they would actually run if you copied them into a python console. We also need to add a sphinx configuration to the Doc folder so we can start building a webpage/pdf manual.
ghost
requested a review
from 
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.
This contains a lot of documentation edits to make docstrings sphinx-compatible.
Most of the docstrings are in RST format, and many have :Example: sections with doctests meant to show usage examples for the code.
This is just the beginning phase of updating the documentation. What needs to happen next is that someone familiar with the library and its functions (parameters, return values, etc.) needs to fill in missing param/type and return/rtype. The :Examples: need to be edited such that they would actually run if you copied them into a python console. We also need to add a sphinx configuration to the Doc folder so we can start building a webpage/pdf manual.
xmldocs isn't actually being used yet, but there are at least a few places where we could plug repetetive parameters into the documentation, so it's a good idea.