-
-
Notifications
You must be signed in to change notification settings - Fork 554
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
Remove RMSE function #3988
Remove RMSE function #3988
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #3988 +/- ##
===========================================
- Coverage 99.58% 99.58% -0.01%
===========================================
Files 257 257
Lines 21252 21242 -10
===========================================
- Hits 21164 21154 -10
Misses 88 88 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the code removed is fine. Please don't remove those comments. They add structure to the code and make it easier to scan. Removing the empty comment lines (#
and nothing else) is fine.
I removed them because they basically all said something along the lines of # functions from file X
from x import y Which does not seem to add anything |
It adds structure and makes the file easier to scan since they are highlighted in different colors by most IDEs |
Imports in pybamm's |
To me it did not add anything since it literally said what was right below that in the code, but I will add it back if you insist. In general my changes like this are just trying to clean up stuff that does not add anything like: #
# Batch Study
#
from .batch_study import BatchStudy which ends up adding a lot of comments for the exact thing that is below it.
I did not run any auto-formatting here and left the imports in groups. The only thing I did for my IDE was move the constants to the bottom of the file in order to stop the warnings about imports coming after code. The comments did not add any hints about which order things needed to be imported, no warnings about problematic stuff, etc. So I don't think they solve the import order problem either However, the constants I moved look like they are not actually used and can probably be removed as well. PyBaMM triggers so many warnings in PyCharm that I often cannot see the real problems from the inspections. I try to clean up what I can as I work |
Ok everything here is passing now besides Lychee |
Description
Minor removal of code and some cleanup of IDE warnings
Fixes #3982
Type of change
Removes old code
Key checklist:
$ 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)$ python run-tests.py --all
(or$ nox -s tests
)$ 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: