Added additional documentation and cleaned up existing doc #6
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
|
Looks good, but why the /// instead of just // ? |
|
appledoc syntax is three slashes |
|
Oh cool, I didn't about that one. 👍 |
lordkev
force-pushed
the
feature/add-documentation
branch
from
a12c5e0
to
1b978cf
Compare
lordkev
added a commit
that referenced
this pull request
Jun 19, 2015
Added additional documentation and cleaned up existing doc
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.
@dmauro @sharpfive
Let me know if you see anything missing or if you think something's overkill. I leaned on the side of thoroughness even if some things were likely obvious anyway.