Added jsdoc to all of the methods and config for Shr. Fixes issue #6. #13
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
This was referenced Oct 4, 2018
|
This looks good. My only comment would be for one or two line comments, I tend to stick with the |
|
Sounds good! I can go through and make the changes, that makes sense. I can commit the changes and it should update this PR. |
|
Hi Sam, I went through and updated the comments to the // format for one or two line comments. I'll go through the rest of the branches and do the same! Let me know if you need anything else! |
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.
In this PR, I fixed issue #6 . There are no breaking changes. I just added JSDoc to all existing methods and functionality. In the next couple PRs some of this will change as I added and removed some code. I have the JSDoc added in those for the updates as well.