More explanation in docstring

pull/41793/merge
HD650 7 years ago committed by Zhikang Zhang
parent 0586cb1536
commit 8b9f707c21

@ -31,6 +31,7 @@ options:
version_added: "2.7" version_added: "2.7"
description: description:
- "The customized message used for a failing assertion" - "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: aliases:
- msg - msg
success_msg: success_msg:
@ -52,10 +53,18 @@ EXAMPLES = '''
- "'foo' in some_command_result.stdout" - "'foo' in some_command_result.stdout"
- "number_of_the_counting == 3" - "number_of_the_counting == 3"
# after version 2.7 both 'msg' and 'fail_msg' can customize failing assertion message
- assert: - assert:
that: that:
- "my_param <= 100" - "my_param <= 100"
- "my_param >= 0" - "my_param >= 0"
fail_msg: "'my_param' must be between 0 and 100" fail_msg: "'my_param' must be between 0 and 100"
success_msg: "'my_param' is 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"
''' '''

Loading…
Cancel
Save