From 5734b4e69ed2deb0414f9aafea0f8639479efd28 Mon Sep 17 00:00:00 2001 From: Martin Krizek Date: Mon, 4 Mar 2019 20:09:55 +0100 Subject: [PATCH] Clarify return value of the sequence lookup (#53275) * Clarify return value of the sequence lookup Fixes #17852 * Mention range filter --- lib/ansible/plugins/lookup/sequence.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/ansible/plugins/lookup/sequence.py b/lib/ansible/plugins/lookup/sequence.py index cfd3389549..73aced83d3 100644 --- a/lib/ansible/plugins/lookup/sequence.py +++ b/lib/ansible/plugins/lookup/sequence.py @@ -15,6 +15,8 @@ DOCUMENTATION = """ - 'Arguments can be specified as key=value pair strings or as a shortcut form of the arguments string is also accepted: [start-]end[/stride][:format].' - 'Numerical values can be specified in decimal, hexadecimal (0x3f8) or octal (0600).' - Starting at version 1.9.2, negative strides are allowed. + - Generated items are strings. Use Jinja2 filters to convert items to preferred type, e.g. ``{{ 1 + item|int }}``. + - See also Jinja2 ``range`` filter as an alternative. options: start: description: number at which to start the sequence @@ -62,7 +64,9 @@ EXAMPLES = """ RETURN = """ _list: - description: generated sequence of numbers or strings + description: + - A list containing generated sequence of items + type: list """ from re import compile as re_compile, IGNORECASE