Update README.md with some more documentation #115
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
…0-based half-open coordinates
Codecov Report
@@ Coverage Diff @@
## master #115 +/- ##
=======================================
Coverage 90.74% 90.74%
=======================================
Files 7 7
Lines 551 551
Branches 150 150
=======================================
Hits 500 500
Misses 51 51 Continue to review full report at Codecov.
|
|
There is also the option of "automatically generated typescript docs" but I kind of prefer the simple hand curated README docs |
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 breaks out the "code chunk" that represents this modules documentation into some distinct sections
It also makes the note about the 0-based half-open coordinates for getLines