Fix typos, grammar, comment clarification and standardization. #85
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
I decided to fix any typos, grammar issues, or unclear comments as well as standardize the format of the comments while reading through the repo to gain a better understanding of how everything works. Nearly all changes are to comments only, however, there is one variable name that was renamed due to a typo.
All comments now start with a capital and any multi-line comments have better punctuation to be more easily read. This brings the comments format closer to what the rust foundation recommends and improves the overall readability. I tried to keep the content of each comment as close to the original as I could, however, there were a few comments that were very difficult to read and those were heavily changed.
Type of change
Please select the right one.
Which part is impacted ?
Checklist