[Documentation] Adding documentation for current guards to use in python3 test module#43209
Open
j-ororke wants to merge 7 commits intoproject-chip:masterfrom
Open
[Documentation] Adding documentation for current guards to use in python3 test module#43209j-ororke wants to merge 7 commits intoproject-chip:masterfrom
j-ororke wants to merge 7 commits intoproject-chip:masterfrom
Conversation
github-actions
bot
added
the
documentation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
The pull request adds valuable documentation for test guards and decorators in the Python test framework. This will significantly help developers understand how to conditionally run test steps or entire tests based on device capabilities. I have suggested a few minor updates to the code snippets to ensure they are self-contained and consistent with other examples in the document by using fully qualified names instead of undefined local variables.
|
PR #43209: Size comparison from 54af27b to e422228 Full report (35 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, efr32, esp32, nrfconnect, nxp, psoc6, qpg, realtek, stm32, telink)
|
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Fixing documentation string error
I dont even know why stylizer made this change
|
PR #43209: Size comparison from 54af27b to 7fba52e Full report (35 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, efr32, esp32, nrfconnect, nxp, psoc6, qpg, realtek, stm32, telink)
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brief documentation added to python.md to help provide a reference for current guards available in the python3 test framework to be utilized to gate tests and test steps from being run in the event that the cluster being tested doesn't contain the attribute, feature, or command needed for that test step to run. Also includes documentation on PICS guard and the run_if_endpoint_matches decorator.
Testing
This is pure documentation only and no testing is needed to be performed to validate this