New documentation to make it clearer! #73
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
|
Overall readability score: 44.1 (🔴 -2.31)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
Readability has gone down but that's because I added a lot of really needed information that includes equations. Honestly a 9 point decrease is not bad considering! |
|
@cansavvy TODO: Rearrange this a tad for readability purposes |
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.
Description
Adding docs everywhere about how things are handled and calculated! I think by writing this I have a better understanding too but this will need some review to make sure:
Closes #72
Review request
Focus on just the changes in the README because the rest of the doc updates are mainly echoing what's in there. (I literally copied and pasted)
Type of change