Enhancements to documentation and testing #456
Merged
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
…EADME with detailed features and guides. - Added advanced tests in unit_tests.py for robustness. - Optimized settings.py for adaptive performance.
|
Hi @Maddesea, thanks for the substantial PR. I'm going to check it bit by bit. First of all, could you please make sure it is passing the tests? |
|
Note: I'll fix the code and amend the PR to accept a few changes and discard the rest (I don't agree with all the changes). |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #456 +/- ##
=======================================
Coverage 96.91% 96.91%
=======================================
Files 22 22
Lines 3370 3370
=======================================
Hits 3266 3266
Misses 104 104 ☔ View full report in Codecov by Sentry. |
vbarbaresi
reviewed
Jan 4, 2024
|
This hasn't been easy (unncessary code, duplicate sections in Readme etc.) but we're nearly there. I'll merge the PR next week. @Maddesea I take it as an incentive to make the docs better but your changes looked quite GPT-like... |
adbar
changed the title
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.
This Pull Request brings a few enhancements to the project:
README Update: Revamped README with a detailed introduction and feature descriptions.
Unit Tests Expansion: Enhanced
unit_tests.pywith new tests for better coverage and robustness.Settings Optimization: Improved
settings.pyfor enhanced performance and adaptability.