-
Notifications
You must be signed in to change notification settings - Fork 48
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
Add docs and tests for CRIT #76
Conversation
6b808b6
to
bf6259b
Compare
Codecov Report
@@ Coverage Diff @@
## master #76 +/- ##
=======================================
Coverage 51.38% 51.38%
=======================================
Files 2 2
Lines 288 288
=======================================
Hits 148 148
Misses 105 105
Partials 35 35 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
dd30b00
to
748a36e
Compare
This commit provides inline documentation that can be used by language servers upon hover. It also adds comments for the internal functions in order to explain their functionality better. Signed-off-by: Prajwal S N <prajwalnadig21@gmail.com>
The end-to-end test uses a simple C program to generate image files and test all commands provided by the crit CLI. Signed-off-by: Prajwal S N <prajwalnadig21@gmail.com>
This test performs decode and encode on an image file and compares the result with the original file. The test passes if both files are equivalent byte for byte. Signed-off-by: Prajwal S N <prajwalnadig21@gmail.com>
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.
LGTM
This PR provides docs and tests for the crit library introduced in #66