[PR #3249/7cefbd2a backport][stable-2.20] Improve failed_when documentation and fix minor errors #3333
Conversation
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
* Improve failed_when documentation and fix minor errors - Add clarifying example for 'or' operator in failed_when conditions - Fix template syntax: remove extra space in Jinja2 braces Signed-off-by: Piyush Malik <piyush.malik@optimoloan.com> * Update docs/docsite/rst/playbook_guide/playbooks_error_handling.rst Co-authored-by: Felix Fontein <felix@fontein.de> --------- Signed-off-by: Piyush Malik <piyush.malik@optimoloan.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 7cefbd2)
oraNod
approved these changes
Dec 3, 2025
oraNod
deleted the
patchback/backports/stable-2.20/7cefbd2a0c80ae0d5b3e7fee2d114ed43f9c05b0/pr-3249
branch
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.
This is a backport of PR #3249 as merged into devel (7cefbd2).
SUMMARY
Improve the Ansible error handling documentation by clarifying failed_when conditions and fixing minor syntax errors.
ISSUE TYPE
COMPONENT NAME
playbook_guide/playbooks_error_handling.rst
ANSIBLE VERSION
N/A
ADDITIONAL INFORMATION
This PR makes three key improvements to the error handling documentation:
Enhanced failed_when explanation: Added a practical example showing how to use the
oroperator in failed_when conditions, making it clearer that users can trigger failure when ANY condition is met (not just all conditions).Template syntax fix: Corrected malformed Jinja2 braces by removing extra space in
{{ log_path }}{{ log_file }}.These changes improve readability and correctness of the documentation without changing any functionality.