internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-04-25 16:06:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

More explanation in docstring

Browse Source
This commit is contained in:
HD650
2018-06-18 14:01:08 -04:00
committed by Zhikang Zhang
parent 0586cb1536
commit 8b9f707c21
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
lib/ansible/modules/utilities/logic/assert.py
View File

@@ -31,6 +31,7 @@ options:
version_added: "2.7"
description:
- "The customized message used for a failing assertion"
- "This argument was called 'msg' before version 2.7, now it's renamed to 'fail_msg' with alias 'msg'"
aliases:
- msg
success_msg:
@@ -52,10 +53,18 @@ EXAMPLES = '''
- "'foo' in some_command_result.stdout"
- "number_of_the_counting == 3"
# after version 2.7 both 'msg' and 'fail_msg' can customize failing assertion message
- assert:
that:
- "my_param <= 100"
- "my_param >= 0"
fail_msg: "'my_param' must be between 0 and 100"
success_msg: "'my_param' is between 0 and 100"
# please use 'msg' when ansible version is smaller than 2.7
- assert:
that:
- "my_param <= 100"
- "my_param >= 0"
msg: "'my_param' must be between 0 and 100"
'''