Please check if your PR fulfills the following requirements:
- [ ] The commit message follows our guidelines
- [ ] Tests for the changes have been added (if applicable)
- [x] Docs have been added / updated (if applicable)
PR Type
What kind of change does this PR introduce?
- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [x] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Other... Please describe:
as mentioned in #323 this should be documented.
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior
Issue Number fixed #n/a
What is the new behavior
Does this PR introduce a breaking change
Other information