Refactor documentation and improve code clarity across modules.#159
Merged
DanielAvdar merged 4 commits intomainfrom May 7, 2025
Merged
Refactor documentation and improve code clarity across modules.#159DanielAvdar merged 4 commits intomainfrom
DanielAvdar merged 4 commits intomainfrom
Conversation
Added comprehensive docstrings to improve clarity, consistency, and understanding of functions, modules, and classes. Simplified and standardized method descriptions and argument explanations while ensuring readability and alignment with project documentation standards. Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Introduced a new 'cov' target in the Makefile to display test coverage directly in the terminal. This provides a quick and readable summary of missing coverage without the need for external files. Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Updated the installation command to specify the optional `[editor]` dependency for users. Added a note emphasizing the core package's dependency-free design for better portability and maintainability. Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## main #159 +/- ##
===========================================
- Coverage 100.00% 99.69% -0.31%
===========================================
Files 12 13 +1
Lines 330 333 +3
===========================================
+ Hits 330 332 +2
- Misses 0 1 +1 ☔ View full report in Codecov by Sentry. |
Signed-off-by: DanielAvdar <66269169+DanielAvdar@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Added comprehensive docstrings to improve clarity, consistency, and understanding of functions, modules, and classes. Simplified and standardized method descriptions and argument explanations while ensuring readability and alignment with project documentation standards.