diff --git a/README.md b/README.md index 58a82b8..8474ff2 100644 --- a/README.md +++ b/README.md @@ -21,9 +21,9 @@ PEP440 is the schema used to describe the versions of Ansible. ### Filter plugins Name | Description --- | --- -ansible.utils.get_path|Get value using path. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.get_path_lookup.rst) -ansible.utils.index_of|Find items in a list. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.netcommon.index_of_lookup.rst) -ansible.utils.to_paths|Convert objects to paths. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.to_paths_lookup.rst) +ansible.utils.get_path|Retrieve the value in a variable using a path. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.get_path_lookup.rst) +ansible.utils.index_of|Find the indicies of items in a list matching some criteria. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.index_of_lookup.rst) +ansible.utils.to_paths|Flatten a complex object into a dictionary of paths and values. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.to_paths_lookup.rst) ### Lookup plugins Name | Description diff --git a/plugins/filter/index_of.py b/plugins/filter/index_of.py index 7a5138d..39f88ac 100644 --- a/plugins/filter/index_of.py +++ b/plugins/filter/index_of.py @@ -19,7 +19,7 @@ from jinja2.filters import environmentfilter @environmentfilter def _index_of(*args, **kwargs): - """Find items in a list. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.netcommon.index_of_lookup.rst)""" + """Find the indicies of items in a list matching some criteria. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.index_of_lookup.rst)""" kwargs["tests"] = args[0].tests args = args[1:] return index_of(*args, **kwargs) diff --git a/plugins/filter/paths.py b/plugins/filter/paths.py index 5db797c..21d5b49 100644 --- a/plugins/filter/paths.py +++ b/plugins/filter/paths.py @@ -25,13 +25,13 @@ from jinja2.filters import environmentfilter def _to_paths(*args, **kwargs): - """Convert objects to paths. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.to_paths_lookup.rst)""" + """Flatten a complex object into a dictionary of paths and values. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.to_paths_lookup.rst)""" return to_paths(*args, **kwargs) @environmentfilter def _get_path(*args, **kwargs): - """Get value using path. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.get_path_lookup.rst)""" + """Retrieve the value in a variable using a path. [See examples](https://github.com/ansible-collections/ansible.utils/blob/main/docs/ansible.utils.get_path_lookup.rst)""" kwargs["environment"] = args[0] args = args[1:] return get_path(*args, **kwargs) diff --git a/tests/sanity/ignore-2.10.txt b/tests/sanity/ignore-2.10.txt index ccf822d..9fa3d47 100644 --- a/tests/sanity/ignore-2.10.txt +++ b/tests/sanity/ignore-2.10.txt @@ -1,2 +1,4 @@ -plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node plugins/module_utils/common/index_of.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node +plugins/filter/paths.py pep8:E501 # ignore line length for filter doc string w/ url +plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node +plugins/filter/index_of.py pep8:E501 # ignore line length for filter doc string w/ url diff --git a/tests/sanity/ignore-2.11.txt b/tests/sanity/ignore-2.11.txt index ccf822d..9fa3d47 100644 --- a/tests/sanity/ignore-2.11.txt +++ b/tests/sanity/ignore-2.11.txt @@ -1,2 +1,4 @@ -plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node plugins/module_utils/common/index_of.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node +plugins/filter/paths.py pep8:E501 # ignore line length for filter doc string w/ url +plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node +plugins/filter/index_of.py pep8:E501 # ignore line length for filter doc string w/ url diff --git a/tests/sanity/ignore-2.9.txt b/tests/sanity/ignore-2.9.txt index ccf822d..9fa3d47 100644 --- a/tests/sanity/ignore-2.9.txt +++ b/tests/sanity/ignore-2.9.txt @@ -1,2 +1,4 @@ -plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node plugins/module_utils/common/index_of.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node +plugins/filter/paths.py pep8:E501 # ignore line length for filter doc string w/ url +plugins/module_utils/common/path.py pylint:ansible-bad-module-import # file's use is limited to filter and lookups on control node +plugins/filter/index_of.py pep8:E501 # ignore line length for filter doc string w/ url