Repository: ansible-collections/amazon.aws

Issue:
Some module docs inconsistencies
##### SUMMARY
In https://github.com/ansible-collections/amazon.aws/pull/72 we identified several places where module docs could have better or more consistent style, especially around capitalization.

##### ISSUE TYPE
- Documentation Report

##### COMPONENT NAME
ec2_eni_info.py
aws_s3.py

It would be good if any patch fixing this also runs https://github.com/ansible-network/collection_prep/blob/master/add_docs.py to generate new docs.


Discussion:
Files identified in the description:
* [`plugins/modules/aws_s3.py`](https://github.com/ansible-collections/amazon.aws/blob/main/plugins/modules/aws_s3.py)
* [`plugins/modules/ec2_eni_info.py`](https://github.com/ansible-collections/amazon.aws/blob/main/plugins/modules/ec2_eni_info.py)

If these files are inaccurate, please update the `component name` section of the description or use the `!component` bot command.

[click here for bot help](https://github.com/ansible/ansibullbot/blob/master/ISSUE_HELP.md)
<!--- boilerplate: components_banner --->
@jillr: Greetings! Thanks for taking the time to open this issue. In order for the community to handle your issue effectively, we need a bit more information.

Here are the items we could not find in your description:
- ansible version

Please set the description of this issue with this template:
https://raw.githubusercontent.com/ansible/ansible/devel/.github/ISSUE_TEMPLATE/bug_report.md

[click here for bot help](https://github.com/ansible/ansibullbot/blob/master/ISSUE_HELP.md)
<!--- boilerplate: issue_missing_data --->
cc @lwade @s-hertel @tremble @wimnat
[click here for bot help](https://github.com/ansible/ansibullbot/blob/master/ISSUE_HELP.md)
<!--- boilerplate: notify --->

Resolving patch:
diff --git a/plugins/doc_fragments/aws.py b/plugins/doc_fragments/aws.py
--- a/plugins/doc_fragments/aws.py
+++ b/plugins/doc_fragments/aws.py
@@ -21,14 +21,14 @@ class ModuleDocFragment(object):
     default: 'no'
   ec2_url:
     description:
-      - Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints).
+      - URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints).
         Ignored for modules where region is required. Must be specified for all other modules if region is not used.
         If not set then the value of the EC2_URL environment variable, if any, is used.
     type: str
     aliases: [ aws_endpoint_url, endpoint_url ]
   aws_secret_key:
     description:
-      - AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
+      - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used.
       - If I(profile) is set this parameter is ignored.
       - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated
         and the options will be made mutually exclusive after 2022-06-01.
@@ -36,7 +36,7 @@ class ModuleDocFragment(object):
     aliases: [ ec2_secret_key, secret_key ]
   aws_access_key:
     description:
-      - AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
+      - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used.
       - If I(profile) is set this parameter is ignored.
       - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated
         and the options will be made mutually exclusive after 2022-06-01.
@@ -44,7 +44,7 @@ class ModuleDocFragment(object):
     aliases: [ ec2_access_key, access_key ]
   security_token:
     description:
-      - AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
+      - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used.
       - If I(profile) is set this parameter is ignored.
       - Passing the I(security_token) and I(profile) options at the same time has been deprecated
         and the options will be made mutually exclusive after 2022-06-01.
diff --git a/plugins/modules/aws_s3.py b/plugins/modules/aws_s3.py
--- a/plugins/modules/aws_s3.py
+++ b/plugins/modules/aws_s3.py
@@ -23,7 +23,7 @@
     type: str
   dest:
     description:
-      - The destination file path when downloading an object/key with a GET operation.
+      - The destination file path when downloading an object/key with a C(GET) operation.
     type: path
   encrypt:
     description:
@@ -46,7 +46,7 @@
     type: int
   headers:
     description:
-      - Custom headers for PUT operation, as a dictionary of C(key=value) and C(key=value,key=value).
+      - Custom headers for C(PUT) operation, as a dictionary of C(key=value) and C(key=value,key=value).
     type: dict
   marker:
     description:
@@ -63,7 +63,7 @@
     type: dict
   mode:
     description:
-      - Switches the module behaviour between C(put) (upload), C(get) (download), C(geturl) (return download url, Ansible 1.3+),
+      - Switches the module behaviour between C(PUT) (upload), C(GET) (download), C(geturl) (return download URL, Ansible 1.3+),
         C(getstr) (download object as string (1.3+)), C(list) (list keys, Ansible 2.0+), C(create) (bucket), C(delete) (bucket),
         delobj (delete object, Ansible 2.0+) and C(copy) object that is already stored in another (bucket).
     required: true
@@ -94,7 +94,7 @@
     type: str
   overwrite:
     description:
-      - Force overwrite either locally on the filesystem or remotely with the object/key. Used with PUT and GET operations.
+      - Force overwrite either locally on the filesystem or remotely with the object/key. Used with C(PUT) and C(GET) operations.
       - Must be a Boolean, C(always), C(never) or C(different).
       - C(true) is the same as C(always).
       - C(false) is equal to C(never).
@@ -127,28 +127,28 @@
     type: bool
   src:
     description:
-      - The source file path when performing a PUT operation.
-      - Either I(content), I(content_base64) or I(src) must be specified for a PUT operation. Ignored otherwise.
+      - The source file path when performing a C(PUT) operation.
+      - Either I(content), I(content_base64) or I(src) must be specified for a C(PUT) operation. Ignored otherwise.
     type: path
   content:
     description:
-      - The content to PUT into an object.
+      - The content to C(PUT) into an object.
       - The parameter value will be treated as a string and converted to UTF-8 before sending it to S3.
         To send binary data, use the I(content_base64) parameter instead.
-      - Either I(content), I(content_base64) or I(src) must be specified for a PUT operation. Ignored otherwise.
+      - Either I(content), I(content_base64) or I(src) must be specified for a C(PUT) operation. Ignored otherwise.
     version_added: "1.3.0"
     type: str
   content_base64:
     description:
-      - The base64-encoded binary data to PUT into an object.
+      - The base64-encoded binary data to C(PUT) into an object.
       - Use this if you need to put raw binary data, and don't forget to encode in base64.
-      - Either I(content), I(content_base64) or I(src) must be specified for a PUT operation. Ignored otherwise.
+      - Either I(content), I(content_base64) or I(src) must be specified for a C(PUT) operation. Ignored otherwise.
     version_added: "1.3.0"
     type: str
   ignore_nonexistent_bucket:
     description:
       - "Overrides initial bucket lookups in case bucket or iam policies are restrictive. Example: a user may have the
-        GetObject permission but no other permissions. In this case using the option mode: get will fail without specifying
+        C(GetObject) permission but no other permissions. In this case using the option mode: get will fail without specifying
         I(ignore_nonexistent_bucket=true)."
     type: bool
     default: false


Test patch: