-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Better documentation and better struct/field naming #29
Conversation
6ac7e84
to
96f1d8e
Compare
Codecov Report
@@ Coverage Diff @@
## main #29 +/- ##
==========================================
+ Coverage 82.16% 85.42% +3.25%
==========================================
Files 10 10
Lines 1060 1077 +17
==========================================
+ Hits 871 920 +49
+ Misses 189 157 -32
Continue to review full report at Codecov.
|
Co-authored-by: Tommaso Allevi <tomallevi@gmail.com>
Co-authored-by: Tommaso Allevi <tomallevi@gmail.com>
Thanks @allevo! Applied your suggestions :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Neat documentation
- Nicer/Simpler types
I like it a lot.
This PR introduces a comprehensive programmatic documentation (rustdoc) and renames all the struct fields to be more descriptive (BREAKING CHANGE).
Closes #28
Closes #6
Screenshots