Please provide a descriptive summary of the changes your Pull Request introduces.
The Software Development section of
the Contributing Guidelines may be useful if you are unfamiliar with linting, pre-commit, docstrings and testing.
NB - This header should be replaced with the description but please complete the below checklist or a short
description of why a particular item is not relevant.
Before submitting a Pull Request please check the following.
[x] Existing tests pass.
[x] Documentation has been updated and builds. Remember to update configuration.md, usage.md, and relevant processing sections under advanced.md.
[x] Pre-commit checks pass.
[x] New functions/methods have typehints and docstrings.
[x] New functions/methods have tests which check the intended behaviour is correct.
Closes #1006
As per PC180 uses rbubley/mirrors-prettier over pre-commit/mirrors-prettier.
TopoStats Pull Requests
Please provide a descriptive summary of the changes your Pull Request introduces.
The Software Development section of the Contributing Guidelines may be useful if you are unfamiliar with linting, pre-commit, docstrings and testing.
NB - This header should be replaced with the description but please complete the below checklist or a short description of why a particular item is not relevant.
Before submitting a Pull Request please check the following.
Existing tests pass.Documentation has been updated and builds. Remember to updateconfiguration.md,usage.md, and relevant processing sections underadvanced.md.New functions/methods have typehints and docstrings.New functions/methods have tests which check the intended behaviour is correct.Optional
N/A