v0.0.5

[sebastienrousseau]

KyberLib v0.0.5 includes several bug fixes, documentation improvements, and the addition of comprehensive test suites. This release focuses on enhancing the overall quality and reliability of the library.

Key Changes:

1. Documentation:

   • Updated documentation macros and KyberLibError for improved clarity and readability.

2. Bug Fixes:

   • Fixed derive declarations to ensure proper functionality.
   • Addressed a warning about an unused result of type Box<dyn Any + Send> in the test suite.

3. Test Suite Enhancements:

   • Added a comprehensive test suite for the WASM module, covering various scenarios and edge cases.
   • Implemented unit tests for rng.rs to ensure the correctness of random number generation.
   • Added unit tests for KyberLibError to verify proper error handling.

4. Code Style and Formatting:

   • Fixed Rustfmt warnings to adhere to the recommended coding style.
   • Applied minor style tweaks and formatting improvements for better code readability.

5. Refactoring:

   • Performed minor refactoring in the test suite to improve code organization and maintainability.

This release aims to provide a more stable and reliable version of KyberLib, with improved documentation, bug fixes, and extensive test coverage. We recommend updating to this version to benefit from these enhancements.

Please note that this release may contain breaking changes. Make sure to review the documentation and update your code accordingly.

We appreciate your continued support and feedback. If you encounter any issues or have suggestions for improvement, please let us know through our issue tracker.

[codecov]

Codecov Report

Attention: Patch coverage is 87.50000% with 12 lines in your changes are missing coverage. Please review.

Project coverage is 80.97%. Comparing base (c41b350) to head (c3989cc).
Report is 1 commits behind head on main.

Files	Patch %	Lines
src/reference/fips202.rs	71.42%	4 Missing ⚠️
src/wasm.rs	0.00%	4 Missing ⚠️
src/error.rs	0.00%	2 Missing ⚠️
src/api.rs	90.00%	1 Missing ⚠️
src/kex.rs	85.71%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #33      +/-   ##
==========================================
+ Coverage   80.64%   80.97%   +0.32%     
==========================================
  Files          16       16              
  Lines        1116     1151      +35     
==========================================
+ Hits          900      932      +32     
- Misses        216      219       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.