Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Do not forget to include all the issues that are connected to this pull request.
Type of change
Put an X in the relevant boxes
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] This change requires a documentation update
How Has This Been Tested?
Please generally describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
[ ] Test A
[ ] Test B
Test Configuration:
OS:
Hardware:
Toolchain:
SDK:
Checklist:
[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have adequately commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings (if there are any, note them and why they could not have been removed)
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules
Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. Do not forget to include all the issues that are connected to this pull request.
Type of change
Put an
Xin the relevant boxesHow Has This Been Tested?
Please generally describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Test Configuration:
Checklist: