Update Examples with FQCN (#67)

Updated module examples with FQCN Signed-off-by: Abhijeet Kasurde <[email protected]> This commit was initially merged in https://github.com/ansible-collections/community.aws See: ansible-collections/community.aws@98173ae
ansible-collections · Oct 17, 2024 · 270ab82 · 270ab82
1 parent 73bb283
commit 270ab82
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 12 deletions.
diff --git a/plugins/modules/ec2_placement_group.py b/plugins/modules/ec2_placement_group.py
@@ -46,19 +46,19 @@
 # Note: These examples do not set authentication details, see the AWS Guide
 # for details.
 
-# Create a placement group.
-- ec2_placement_group:
+- name: Create a placement group.
+  community.aws.ec2_placement_group:
     name: my-cluster
     state: present
 
-# Create a Spread placement group.
-- ec2_placement_group:
+- name: Create a Spread placement group.
+  community.aws.ec2_placement_group:
     name: my-cluster
     state: present
     strategy: spread
 
-# Delete a placement group.
-- ec2_placement_group:
+- name: Delete a placement group.
+  community.aws.ec2_placement_group:
     name: my-cluster
     state: absent
 

diff --git a/plugins/modules/ec2_placement_group_info.py b/plugins/modules/ec2_placement_group_info.py
@@ -29,22 +29,23 @@
 
 '''
 
-EXAMPLES = '''
+EXAMPLES = r'''
 # Note: These examples do not set authentication details or the AWS region,
 # see the AWS Guide for details.
 
-# List all placement groups.
-- ec2_placement_group_info:
+- name: List all placement groups.
+  community.aws.ec2_placement_group_info:
   register: all_ec2_placement_groups
 
-# List two placement groups.
-- ec2_placement_group_info:
+- name: List two placement groups.
+  community.aws.ec2_placement_group_info:
     names:
      - my-cluster
      - my-other-cluster
   register: specific_ec2_placement_groups
 
-- debug: msg="{{ specific_ec2_placement_groups | json_query(\"[?name=='my-cluster']\") }}"
+- debug:
+    msg: "{{ specific_ec2_placement_groups | json_query(\"[?name=='my-cluster']\") }}"
 
 '''