Add docstrings to FuzzyDict methods#5242
Merged
agriyakhetarpal merged 3 commits intopybamm-team:developfrom Nov 1, 2025
Merged
Add docstrings to FuzzyDict methods#5242agriyakhetarpal merged 3 commits intopybamm-team:developfrom
agriyakhetarpal merged 3 commits intopybamm-team:developfrom
Conversation
valentinsulzer
approved these changes
Oct 31, 2025
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #5242 +/- ##
========================================
Coverage 98.78% 98.78%
========================================
Files 321 321
Lines 27643 27643
========================================
Hits 27306 27306
Misses 337 337 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
agriyakhetarpal
approved these changes
Nov 1, 2025
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
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.
Description
Added a proper docstring to
FuzzyDict.copyexplaining its return value and behavior.This improves the API documentation and helps users understand how to use this method correctly.
Contribution to #3392
Fixes #4845
Type of change
Update in CHANGELOG.md:
Important checks:
Please confirm the following before marking the PR as ready for review:
[x] No style issues:
nox -s pre-commit[x] All tests pass:
nox -s tests[x] The documentation builds:
nox -s doctests[x] Code is commented for hard-to-understand areas
[x] Tests added that prove fix is effective or that feature works