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

Fix incorrect error message #4672

Merged
merged 2 commits into from
Dec 13, 2024
Merged

Fix incorrect error message #4672

merged 2 commits into from
Dec 13, 2024

Conversation

aabills
Copy link
Contributor

@aabills aabills commented Dec 13, 2024

Description

When the parameters dictionary is called with a key of Primary: Some parameter [some unit], pybamm directs the user to use the dimensional version of that parameter. This is inconsequential but I find it annoying.

this PR simply corrects that logic.

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

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

@aabills aabills requested a review from a team as a code owner December 13, 2024 02:03
kratman
kratman previously approved these changes Dec 13, 2024
Copy link
Contributor

@kratman kratman left a comment

Choose a reason for hiding this comment

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

Seems good

Copy link

codecov bot commented Dec 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.21%. Comparing base (72c23ea) to head (864388f).
Report is 25 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #4672   +/-   ##
========================================
  Coverage    99.21%   99.21%           
========================================
  Files          302      302           
  Lines        22858    22880   +22     
========================================
+ Hits         22679    22701   +22     
  Misses         179      179           

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

@aabills
Copy link
Contributor Author

aabills commented Dec 13, 2024

added a quick test to hit coverage

@aabills aabills merged commit 1d303c9 into develop Dec 13, 2024
26 checks passed
@aabills aabills deleted the fix-incorrect-error-msg branch December 13, 2024 04:51
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.

2 participants