Skip to content

Add nbstripout pre-commit hook#428

Merged
NicolaCourtier merged 8 commits into
developfrom
427-pre-commit-nbstripout
Jul 31, 2024
Merged

Add nbstripout pre-commit hook#428
NicolaCourtier merged 8 commits into
developfrom
427-pre-commit-nbstripout

Conversation

@NicolaCourtier

Copy link
Copy Markdown
Member

Description

Add the nbstripout pre-commit hook from: https://github.com/kynan/nbstripout

Issue reference

Fixes #427

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.

@NicolaCourtier NicolaCourtier linked an issue Jul 28, 2024 that may be closed by this pull request
@codecov

codecov Bot commented Jul 28, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.14%. Comparing base (d9b718b) to head (1c66e11).
Report is 588 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #428   +/-   ##
========================================
  Coverage    98.14%   98.14%           
========================================
  Files           44       44           
  Lines         2697     2697           
========================================
  Hits          2647     2647           
  Misses          50       50           

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

@NicolaCourtier
NicolaCourtier marked this pull request as ready for review July 28, 2024 19:08
@NicolaCourtier

Copy link
Copy Markdown
Member Author

Note that the failed project coverage check is simply due to the extra Changelog entry.

@agriyakhetarpal agriyakhetarpal left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

These changes LGTM in principle; thank you, @NicolaCourtier!

@BradyPlanden BradyPlanden left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks great, thanks @NicolaCourtier! The patch coverage is down due to this flaky test: https://app.codecov.io/gh/pybop-team/PyBOP/pull/428/indirect-changes which I've fixed in #411:

I've left a few comments/suggestions, otherwise LGTM.

Comment thread examples/notebooks/LG_M50_ECM/1-single-pulse-circuit-model.ipynb
Comment thread examples/notebooks/comparing_cost_functions.ipynb
Comment thread .pre-commit-config.yaml Outdated
NicolaCourtier and others added 2 commits July 31, 2024 13:14
Co-authored-by: Brady Planden <55357039+BradyPlanden@users.noreply.github.com>
@NicolaCourtier
NicolaCourtier merged commit 08fa1cb into develop Jul 31, 2024
@NicolaCourtier
NicolaCourtier deleted the 427-pre-commit-nbstripout branch July 31, 2024 14:07
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.

Clean metadata from notebooks during pre-commit

3 participants