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

Additions to ruff rules #386

Merged
merged 17 commits into from
Jul 11, 2024
Merged

Additions to ruff rules #386

merged 17 commits into from
Jul 11, 2024

Conversation

BradyPlanden
Copy link
Member

Description

Adds additional linting rules to ruff (deployed via pre-commit) and corresponding fixes.

Issue reference

Fixes #385

Review

Before you mark your PR as ready for review, please ensure that you've considered the following:

  • Updated the CHANGELOG.md in reverse chronological order (newest at the top) with a concise description of the changes, including the PR number.
  • Noted any breaking changes, including details on how it might impact existing functionality.

Type of change

  • New Feature: A non-breaking change that adds new functionality.
  • Optimization: A code change that improves performance.
  • Examples: A change to existing or additional examples.
  • Bug Fix: A non-breaking change that addresses an issue.
  • Documentation: Updates to documentation or new documentation for new features.
  • Refactoring: Non-functional changes that improve the codebase.
  • Style: Non-functional changes related to code style (formatting, naming, etc).
  • Testing: Additional tests to improve coverage or confirm functionality.
  • Other: (Insert description of change)

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 unit tests pass: $ nox -s tests
  • The documentation builds: $ nox -s doctest

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

Further checks:

  • Code is well-commented, especially in complex or unclear areas.
  • Added tests that prove my fix is effective or that my feature works.
  • Checked that coverage remains or improves, and added tests if necessary to maintain or increase coverage.

Thank you for contributing to our project! Your efforts help us to deliver great software.

Copy link

codecov bot commented Jul 3, 2024

Codecov Report

Attention: Patch coverage is 97.56098% with 2 lines in your changes missing coverage. Please review.

Project coverage is 97.88%. Comparing base (97aba6f) to head (bd3d59b).
Report is 649 commits behind head on develop.

Files with missing lines Patch % Lines
pybop/models/lithium_ion/base_echem.py 50.00% 1 Missing ⚠️
pybop/plotting/plotly_manager.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #386      +/-   ##
===========================================
+ Coverage    97.78%   97.88%   +0.09%     
===========================================
  Files           43       43              
  Lines         2579     2598      +19     
===========================================
+ Hits          2522     2543      +21     
+ Misses          57       55       -2     

☔ 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, @BradyPlanden! I am not sure about the drop in coverage however... maybe we can ignore that safely?

@BradyPlanden
Copy link
Member Author

Thanks for the review @agriyakhetarpal, yes - those tests need a bit of thought to wrangle back in. Work for another PR.

pyproject.toml Outdated Show resolved Hide resolved
@BradyPlanden BradyPlanden merged commit 4638a60 into develop Jul 11, 2024
29 of 30 checks passed
@BradyPlanden BradyPlanden deleted the ruff-lint-changes branch July 11, 2024 08:08
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.

Additional rules to ruff
2 participants