Documented v2_runner_on_failed method in Callback class #83267
Merged
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
Added type declarations and a docstring to the
v2_runner_on_failed
method of the Callback class to explain the purpose of the method and the parameters that the method will accept. The docstring also provides additional information for developers who want to use the method in custom callback plugins. This PR incorporates feedback from @bcoca and @webknjaz.ISSUE TYPE
ADDITIONAL INFORMATION
This change does not alter the method's output. A
block-rescue
play using anansible.builtin.fail
module ran with no issues. All tests in test.units.plugins.callback.test_callback passed