Skip to content

Commit

Permalink
Clarify return value of the sequence lookup (#53275)
Browse files Browse the repository at this point in the history
* Clarify return value of the sequence lookup

Fixes #17852

* Mention range filter
  • Loading branch information
mkrizek authored and bcoca committed Mar 4, 2019
1 parent 4cf7854 commit 5734b4e
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion lib/ansible/plugins/lookup/sequence.py
Expand Up @@ -15,6 +15,8 @@
- '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
Expand Down Expand Up @@ -62,7 +64,9 @@

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
Expand Down

0 comments on commit 5734b4e

Please sign in to comment.