Please check if your PR fulfills the following requirements:
[ ] Tests for the changes have been added (for bug fixes / features)
[x] Docs have been reviewed and added / updated if needed (for bug fixes / features)
Some docs updates need to be made in the COAsT-site repo, in a separate PR. See contributing to documentation for details.
[ ] Build (./build.sh) was run locally and no errors reported. NB not sure about this requirement: GitActions test this
[ ] Lint (pylint .) has passed locally and any fixes were made for failures. NB not sure about this requirement: GitActions test this with black
Pull request type
Please check the type of change your PR introduces:
- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, renaming)
- [x] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [x] Documentation content changes
- [ ] Other (please describe):
## What is the current behavior?
Issue URL: #
What is the new behavior?
-
Checklist
[ ] Code compiles correctly
[ ] Created tests which fail without the change (if possible)
Pull request checklist
Please check if your PR fulfills the following requirements:
COAsT-site
repo, in a separate PR. See contributing to documentation for details../build.sh
) was run locally and no errors reported. NB not sure about this requirement: GitActions test thispylint .
) has passed locally and any fixes were made for failures. NB not sure about this requirement: GitActions test this withblack
Pull request type
Please check the type of change your PR introduces: - [ ] Bugfix - [ ] Feature - [ ] Code style update (formatting, renaming) - [x] Refactoring (no functional changes, no api changes) - [ ] Build related changes - [x] Documentation content changes - [ ] Other (please describe): ## What is the current behavior?Issue URL: #
What is the new behavior?
-
Checklist
pip install . && pytest unit_testing/unit_test.py -s
)Does this introduce a breaking change?
Other information