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

Docs base solver #3967

Merged
merged 2 commits into from
Apr 6, 2024
Merged

Conversation

Jiabin-Wang
Copy link
Contributor

@Jiabin-Wang Jiabin-Wang commented Apr 5, 2024

Description

This is the practice of contribute to the PyBaMM (creating PR and updating docstring). I edited docstring in function solve and step in pybamm/solvers/base_solver.py.
These have been mentioned in the #3392 (API Docs - Small fixes suitable for first time contributors)

Type of change

I have made changes following the suggestion in the #3392 API Docs - Small fixes suitable for first time contributors: pybamm.BaseSolver.solve and pybamm.BaseSolver.step

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

@Jiabin-Wang
Copy link
Contributor Author

As part of the preparation for the April 2024 training

Copy link

codecov bot commented Apr 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.58%. Comparing base (fe4ac31) to head (bac9294).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #3967   +/-   ##
========================================
  Coverage    99.58%   99.58%           
========================================
  Files          257      257           
  Lines        21251    21251           
========================================
  Hits         21163    21163           
  Misses          88       88           

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

@martinjrobins martinjrobins merged commit abc4283 into pybamm-team:develop Apr 6, 2024
40 checks passed
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.

None yet

5 participants