This PR contains changes in the test-utils/README.md file with updated docs covering annotations update and also formatting.
🤔 Motivation and Context
In order to provide a better understanding of the testkit annotations update, we have added better docs and code-snippets in the readme file so all the doc about its usage is here.
🧪 How Has This Been Tested?
Reviewed how it's rendered using Visual Studio Code markdown preview.
⚒️ Does the PR contain new tests or refactored old ones?
No, just documentation.
📷 Screenshots (if appropriate)
No, just documentation
📦 Types of changes
[ ] New feature (non-breaking change which adds functionality)
[X] Enhancement to a current functionality
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Bug fix (non-breaking change which fixes an issue. Please add issue link here too).
✅ Checklist
[X] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[ ] This PR contains new tests that cover the new code.
[ ] This PR refactor previous tests to cover the new code.
[ ] This PR is part of a set of PRs that build a bigger feature. If so, please, add here links to previously merged or open PRs.
Along this PR I've left come comments in the related docs-repo/PR with suggested changes that can be done there as well.
📃 Description
This PR contains changes in the test-utils/README.md file with updated docs covering annotations update and also formatting.
🤔 Motivation and Context
In order to provide a better understanding of the testkit annotations update, we have added better docs and code-snippets in the readme file so all the doc about its usage is here.
🧪 How Has This Been Tested?
Reviewed how it's rendered using Visual Studio Code markdown preview.
⚒️ Does the PR contain new tests or refactored old ones?
No, just documentation.
📷 Screenshots (if appropriate)
No, just documentation
📦 Types of changes
✅ Checklist
Along this PR I've left come comments in the related docs-repo/PR with suggested changes that can be done there as well.