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

Divide examples into folders #559

Merged
merged 7 commits into from
Nov 22, 2024
Merged

Conversation

NicolaCourtier
Copy link
Member

Description

This pull request contains no changes except to divide the existing examples into a more descriptive folder structure.

Issue reference

Fixes #282

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 Nov 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.14%. Comparing base (c8b00e6) to head (18248d7).
Report is 19 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #559      +/-   ##
===========================================
+ Coverage    99.08%   99.14%   +0.05%     
===========================================
  Files           52       55       +3     
  Lines         3605     3848     +243     
===========================================
+ Hits          3572     3815     +243     
  Misses          33       33              

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


🚨 Try these New Features:

@NicolaCourtier NicolaCourtier marked this pull request as ready for review November 18, 2024 18:59
Copy link
Member

@BradyPlanden BradyPlanden 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, thanks @NicolaCourtier! There appears to be one remaining link that needs to be fixed. I would consider changing the directory name battery_parameterisation to parameterisation for symmetry with design_optimisation, but I'll leave that with you.

@NicolaCourtier
Copy link
Member Author

Thanks Brady, the link should be fixed on merge...

@NicolaCourtier NicolaCourtier merged commit 4116c5c into develop Nov 22, 2024
30 of 31 checks passed
@NicolaCourtier NicolaCourtier deleted the 282-restructure-examples branch November 22, 2024 09:49
@NicolaCourtier NicolaCourtier self-assigned this Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Restructure examples directory
2 participants