From e0551c012732099369a8bcfac6dcde33cdcdbc32 Mon Sep 17 00:00:00 2001 From: Priyam Sahoo <42550351+priyamsahoo@users.noreply.github.com> Date: Tue, 22 Jun 2021 05:18:07 +0530 Subject: [PATCH] Fix documentation issues (#80) Fixed documentation issues Reviewed-by: https://github.com/apps/ansible-zuul --- changelogs/config.yaml | 2 ++ .../fragments/update_doc_for_usable_range_filter_plugin.yml | 3 +++ docs/ansible.utils.usable_range_filter.rst | 4 ++-- plugins/filter/usable_range.py | 4 ++-- 4 files changed, 9 insertions(+), 4 deletions(-) create mode 100644 changelogs/fragments/update_doc_for_usable_range_filter_plugin.yml diff --git a/changelogs/config.yaml b/changelogs/config.yaml index ee98384..626b290 100644 --- a/changelogs/config.yaml +++ b/changelogs/config.yaml @@ -25,5 +25,7 @@ sections: - Bugfixes - - known_issues - Known Issues +- - doc_changes + - Documentation Changes title: Ansible Utils Collection trivial_section_name: trivial diff --git a/changelogs/fragments/update_doc_for_usable_range_filter_plugin.yml b/changelogs/fragments/update_doc_for_usable_range_filter_plugin.yml new file mode 100644 index 0000000..007c444 --- /dev/null +++ b/changelogs/fragments/update_doc_for_usable_range_filter_plugin.yml @@ -0,0 +1,3 @@ +--- +doc_changes: + - Update doc for usable_range filter plugin diff --git a/docs/ansible.utils.usable_range_filter.rst b/docs/ansible.utils.usable_range_filter.rst index 7f32fad..6fa99f4 100644 --- a/docs/ansible.utils.usable_range_filter.rst +++ b/docs/ansible.utils.usable_range_filter.rst @@ -137,7 +137,7 @@ Examples #### Simple Use-case (looping through the list result) - - name: Expand and produce list of usable IP addresses in 192.0.2.0/28 + - name: Expand and produce list of usable IP addresses in 127.0.0.0/28 ansible.builtin.set_fact: data1: "{{ '127.0.0.0/28' | ansible.utils.usable_range }}" @@ -145,7 +145,7 @@ Examples shell: "ping -c 1 {{ item }}" loop: "{{ data1.usable_ips[1:] }}" - # TASK [Expand and produce list of usable IP addresses in 192.0.2.0/28] ****************************** + # TASK [Expand and produce list of usable IP addresses in 127.0.0.0/28] ****************************** # ok: [localhost] # TASK [Ping all but first IP addresses from the generated list] ************************************* diff --git a/plugins/filter/usable_range.py b/plugins/filter/usable_range.py index dc4ce11..1188bf2 100644 --- a/plugins/filter/usable_range.py +++ b/plugins/filter/usable_range.py @@ -112,7 +112,7 @@ EXAMPLES = r""" #### Simple Use-case (looping through the list result) -- name: Expand and produce list of usable IP addresses in 192.0.2.0/28 +- name: Expand and produce list of usable IP addresses in 127.0.0.0/28 ansible.builtin.set_fact: data1: "{{ '127.0.0.0/28' | ansible.utils.usable_range }}" @@ -120,7 +120,7 @@ EXAMPLES = r""" shell: "ping -c 1 {{ item }}" loop: "{{ data1.usable_ips[1:] }}" -# TASK [Expand and produce list of usable IP addresses in 192.0.2.0/28] ****************************** +# TASK [Expand and produce list of usable IP addresses in 127.0.0.0/28] ****************************** # ok: [localhost] # TASK [Ping all but first IP addresses from the generated list] *************************************