Skip to content

Add docstrings to FuzzyDict methods#5242

Merged
agriyakhetarpal merged 3 commits intopybamm-team:developfrom
swastim01:docs/fuzzydict-docs
Nov 1, 2025
Merged

Add docstrings to FuzzyDict methods#5242
agriyakhetarpal merged 3 commits intopybamm-team:developfrom
swastim01:docs/fuzzydict-docs

Conversation

@swastim01
Copy link
Contributor

@swastim01 swastim01 commented Oct 26, 2025

Description

Added a proper docstring to FuzzyDict.copy explaining 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

  • Documentation update
    Update in CHANGELOG.md:
- Added docstring to `FuzzyDict.copy` explaining its return value and behavior. ([#5242](https://github.com/pybamm-team/PyBaMM/pull/5242))

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

@swastim01 swastim01 requested a review from a team as a code owner October 26, 2025 12:37
@codecov
Copy link

codecov bot commented Oct 31, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.78%. Comparing base (f27f7ee) to head (2ec5fd3).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@agriyakhetarpal agriyakhetarpal merged commit fe522ac into pybamm-team:develop Nov 1, 2025
22 checks passed
@swastim01 swastim01 deleted the docs/fuzzydict-docs branch November 8, 2025 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix the docs in pybamm.FuzzyDict class

3 participants