From 8b9f707c214305c253dccac65f69dc0e4fc3fd02 Mon Sep 17 00:00:00 2001 From: HD650 Date: Mon, 18 Jun 2018 14:01:08 -0400 Subject: [PATCH] More explanation in docstring --- lib/ansible/modules/utilities/logic/assert.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/lib/ansible/modules/utilities/logic/assert.py b/lib/ansible/modules/utilities/logic/assert.py index 0c0cff2f59..e2a515e8c9 100644 --- a/lib/ansible/modules/utilities/logic/assert.py +++ b/lib/ansible/modules/utilities/logic/assert.py @@ -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" '''