Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename CrateTermination to CRateTermination because the step is CRate #4834

Merged
merged 3 commits into from
Feb 11, 2025

Conversation

aabills
Copy link
Contributor

@aabills aabills commented Feb 11, 2025

Description

I noticed today that to use a step for c-rate you call pybamm.step.CRate but to create a termination you use pybamm.step.CrateTermination. This is inconsistent, so this pr fixes it.

Fixes # (issue)

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

  • New feature (non-breaking change which adds functionality)
  • Optimization (back-end change that speeds up the code)
  • Bug fix (non-breaking change which fixes an issue)

Key checklist:

  • No style issues: $ pre-commit run (or $ nox -s pre-commit) (see CONTRIBUTING.md for how to set this up to run automatically when committing locally, in just two lines of code)
  • All tests pass: $ python -m pytest (or $ nox -s tests)
  • The documentation builds: $ python -m pytest --doctest-plus src (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ nox -s quick.

Further checks:

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copy link

codecov bot commented Feb 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.70%. Comparing base (7419219) to head (d956513).
Report is 2 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4834   +/-   ##
========================================
  Coverage    98.70%   98.70%           
========================================
  Files          303      303           
  Lines        23314    23340   +26     
========================================
+ Hits         23011    23037   +26     
  Misses         303      303           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@agriyakhetarpal agriyakhetarpal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @aabills! Could you please add a test for the warning as the coverage has apparently dropped?

CHANGELOG.md Outdated Show resolved Hide resolved
@kratman kratman enabled auto-merge (squash) February 11, 2025 19:06
@kratman kratman merged commit 1010e24 into pybamm-team:develop Feb 11, 2025
25 checks passed
RohitP2005 pushed a commit to RohitP2005/PyBaMM that referenced this pull request Feb 13, 2025
…pybamm-team#4834)

* rename CrateTermination to CRateTermination because the step is CRate

* comments
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.

4 participants