Add RDoc pages on tag #428
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
kattrali
approved these changes
Feb 6, 2018
There was a problem hiding this comment.
Looks good, I made a few small tweaks:
- Added a custom formatter as the default had low density for class/method info
- Switched the markup type to markdown. There were some otherwise bad looking code blocks.
- Moved documentation on
initializefunctions to the class level, as the class is really what they are documenting.
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.
Adds a command to travis-ci to build and upload the repositories rdocs to the repository page.
In addition, added basic informational rdoc comments to the majority of public methods.