Minor changes to code to rename "exp" experiment instances to demand to avoid confusion with exponentials. Also fixed example in README, which had a typo, wanted a 1C discharge, not C/10.
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.
[ ] New feature (non-breaking change which adds functionality)
[ ] Optimization (back-end change that improves speed/readability/etc.)
[ ] Bug fix (non-breaking change which fixes an issue)
[x] Cleanup
Key checklist:
[x] No style issues: $ nox -s linter [-- format]
[x] Code is free of misspellings: $ nox -s codespell [-- write]
[x] All tests pass: $ nox -s tests
[x] Badges are updated: $ nox -s badges
The optional -- format and -- write arguments (see above) attempt to correct formatting issues prior to running the linter, and spelling mistakes prior to running the spellcheck, respectively. You can also run all of the above checks using $ nox -s pre-commit instead of running them individually.
Further checks:
[x] The documentation builds: $ nox -s docs.
[x] Code is commented, particularly in hard-to-understand areas.
[x] Tests are added that prove fix is effective or that feature works.
Description
Minor changes to code to rename "exp" experiment instances to demand to avoid confusion with exponentials. Also fixed example in README, which had a typo, wanted a 1C discharge, not C/10.
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:
$ nox -s linter [-- format]
$ nox -s codespell [-- write]
$ nox -s tests
$ nox -s badges
The optional
-- format
and-- write
arguments (see above) attempt to correct formatting issues prior to running the linter, and spelling mistakes prior to running the spellcheck, respectively. You can also run all of the above checks using$ nox -s pre-commit
instead of running them individually.Further checks:
$ nox -s docs
.