Documentation & overall project review#113
Open
f1i3g3 wants to merge 32 commits into
Open
Conversation
2 tasks
…riment into documentation
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
1 participant
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.
Summary
Performed a full documentation and codebase-wide review across the entire project, including production modules and tests. Standardized all documentation to NumPy-style docstrings.
Solve the issue: #102
Quick changelog
What's new?
All docstrings have been migrated to a consistent NumPy-style format, improving readability, maintainability, and onboarding experience for new contributors. Module-level documentation was added or improved where missing, ensuring that each package has a clearly defined responsibility.
During the review process, the entire codebase was inspected for clarity and correctness. Potential issues, questionable patterns, and edge cases were identified and explicitly marked for future iteration.