-
-
Notifications
You must be signed in to change notification settings - Fork 570
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
pybamm.Simulation.save, filename arg is not documented #3602
Merged
valentinsulzer
merged 12 commits into
pybamm-team:develop
from
AbhishekChaudharii:issue_3392_improve_API_documentation
Dec 8, 2023
Merged
pybamm.Simulation.save, filename arg is not documented #3602
valentinsulzer
merged 12 commits into
pybamm-team:develop
from
AbhishekChaudharii:issue_3392_improve_API_documentation
Dec 8, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #3602 +/- ##
========================================
Coverage 99.58% 99.58%
========================================
Files 257 257
Lines 20708 20708
========================================
Hits 20623 20623
Misses 85 85 ☔ View full report in Codecov by Sentry. |
valentinsulzer
approved these changes
Dec 8, 2023
@all-contributors add @AbhishekChaudharii for docs |
@tinosulzer @AbhishekChaudharii already contributed before to doc |
46 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added documentation for filename argument in simulation.py
Fixes #3601
Related #3392
Type of change
Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.
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: