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

Removes param = self.param to use self.param directly #4494

Merged
merged 6 commits into from
Oct 10, 2024

Conversation

medha-14
Copy link
Contributor

@medha-14 medha-14 commented Oct 6, 2024

Description

Used regex accompanied with some manual checking and have removed param = self.param and have modified the code to use self.param directly.
Fixes #4484

Type of change

  • 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 run-tests.py --all (or $ nox -s tests)
  • The documentation builds: $ python run-tests.py --doctest (or $ nox -s doctests)

You can run integration tests, unit tests, and doctests together at once, using $ python run-tests.py --quick (or $ 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 Oct 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.42%. Comparing base (e4eb82a) to head (795b8dd).
Report is 182 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #4494      +/-   ##
===========================================
- Coverage    99.42%   99.42%   -0.01%     
===========================================
  Files          299      299              
  Lines        22739    22679      -60     
===========================================
- Hits         22608    22548      -60     
  Misses         131      131              

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

@valentinsulzer
Copy link
Member

I think this change makes the code harder to read

@brosaplanella
Copy link
Member

I think this change makes the code harder to read

For reference, see discussion in #4484

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.

Couple mistakes

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.

Looks good now.

To address the readability concerns from this change, I think the best approach is that we should move towards breaking up the long functions into much smaller ones. That way we can be clear that we are using class memory while also making the code easier to read. This is outside the scope of this PR though

@kratman kratman merged commit 0efe5f6 into pybamm-team:develop Oct 10, 2024
25 of 26 checks passed
@medha-14 medha-14 deleted the self_param branch October 11, 2024 04:10
pkalbhor pushed a commit to pkalbhor/PyBaMM that referenced this pull request Nov 15, 2024
…m#4494)

* 3 files done

* all occurances changed

* added changelog and fixed spectral_volume issue

* fixed docs

---------

Co-authored-by: Eric G. Kratz <[email protected]>
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.

Remove param = self.param and use self.param directly instead
4 participants