Documentation fixes (#1151)

Signed-off-by: Alina Buzachis <abuzachis@redhat.com>

README.md

@@ -9,7 +9,7 @@ Documentation of individual modules is [available in the Ansible docs site](http
 
 ## Installation
 
-It is recommended to run ansible in [Virtualenv](https://virtualenv.pypa.io/en/latest/) 
+It is recommended to run ansible in [Virtualenv](https://virtualenv.pypa.io/en/latest/)
 
 ## Requirements
 
@@ -71,7 +71,7 @@ For existing Ansible roles, please also reference the full namespace, collection
 
 ### Plugins
 
-To use a pluign from Azure collection, please reference the full namespace, collection name, and plugins name that you want to use:
+To use a plugin from Azure collection, please reference the full namespace, collection name, and plugins name that you want to use:
 
 ```yaml
 ---

plugins/modules/azure_rm_adgroup_info.py

@@ -26,15 +26,15 @@
         type: str
     attribute_name:
         description:
-            - The name of an attribute that you want to match to attribute_value.
-            - If attribute_name is not a collection type it will return groups where attribute_name is equal to attribute_value.
-            - If attribute_name is a collection type it will return groups where attribute_value is in attribute_name.
+            - The name of an attribute that you want to match to I(attribute_value).
+            - If I(attribute_name) is not a collection type it will return groups where I(attribute_name) is equal to I(attribute_value).
+            - If I(attribute_name) is a collection type it will return groups where I(attribute_value) is in I(attribute_name).
         type: str
     attribute_value:
         description:
             - The value to match attribute_name to.
-            - If attribute_name is not a collection type it will return groups where attribute_name is equal to attribute_value.
-            - If attribute_name is a collection type it will groups users where attribute_value is in attribute_name.
+            - If I(attribute_name) is not a collection type it will return groups where I(attribute_name) is equal to I(attribute_value).
+            - If I(attribute_name) is a collection type it will groups users where I(attribute_value) is in I(attribute_name).
         type: str
     odata_filter:
         description:

plugins/modules/azure_rm_aduser.py

@@ -96,17 +96,17 @@
         type: str
     attribute_name:
         description:
-            - The name of an attribute that you want to match to attribute_value.
-            - If attribute_name is not a collection type it will update or delete the user where attribute_name is equal to attribute_value.
-            - If attribute_name is a collection type it will update or delete the user where attribute_value is in attribute_name.
+            - The name of an attribute that you want to match to I(attribute_value).
+            - If I(attribute_name) is not a collection type it will update or delete the user where I(attribute_name) is equal to I(attribute_value).
+            - If I(attribute_name) is a collection type it will update or delete the user where I(attribute_value) is in I(attribute_name).
             - Mutually exclusive with I(object_id), I(user_principal_name), and I(odata_filter).
             - Required together with I(attribute_value).
         type: str
     attribute_value:
         description:
-            - The value to match attribute_name to.
-            - If attribute_name is not a collection type it will update or delete the user where attribute_name is equal to attribute_value.
-            - If attribute_name is a collection type it will update or delete the user where attribute_value is in attribute_name.
+            - The value to match I(attribute_name) to.
+            - If I(attribute_name) is not a collection type it will update or delete the user where I(attribute_name) is equal to I(attribute_value).
+            - If I(attribute_name) is a collection type it will update or delete the user where I(attribute_value) is in I(attribute_name).
             - Required together with I(attribute_name).
         type: str
     odata_filter:

plugins/modules/azure_rm_aduser_info.py

@@ -38,27 +38,27 @@
     attribute_name:
         description:
             - The name of an attribute that you want to match to attribute_value.
-            - If attribute_name is not a collection type it will return users where attribute_name is equal to attribute_value.
-            - If attribute_name is a collection type it will return users where attribute_value is in attribute_name.
+            - If I(attribute_name) is not a collection type it will return users where I(attribute_name) is equal to I(attribute_value).
+            - If I(attribute_name) is a collection type it will return users where I(attribute_value) is in I(attribute_name).
             - Mutually exclusive with I(object_id), I(user_principal_name), I(odata_filter) and I(all).
             - Required together with I(attribute_value).
         type: str
     attribute_value:
         description:
             - The value to match attribute_name to.
-            - If attribute_name is not a collection type it will return users where attribute_name is equal to attribute_value.
-            - If attribute_name is a collection type it will return users where attribute_value is in attribute_name.
+            - If I(attribute_name) is not a collection type it will return users where I(attribute_name) is equal to I(attribute_value).
+            - If I(attribute_name) is a collection type it will return users where I(attribute_value) is in I(attribute_name).
             - Required together with I(attribute_name).
         type: str
     odata_filter:
         description:
-            - returns users based on the the OData filter passed into this parameter.
+            - Returns users based on the the OData filter passed into this parameter.
             - Mutually exclusive with I(object_id), I(attribute_name), I(user_principal_name) and I(all).
         type: str
     all:
         description:
-            - If True, will return all users in tenant.
-            - If False will return no users.
+            - If C(True), will return all users in tenant.
+            - If C(False) will return no users.
             - It is recommended that you instead identify a subset of users and use filter.
             - Mutually exclusive with I(object_id), I(attribute_name), I(odata_filter) and I(user_principal_name).
         type: bool

plugins/modules/azure_rm_aksagentpool_info.py

@@ -14,7 +14,7 @@
 version_added: '1.14.0'
 short_description: Show the details for a node pool in the managed Kubernetes cluster
 description:
-    - Get the details for a node pool in the managed Kubernetes cluster
+    - Get the details for a node pool in the managed Kubernetes cluster.
 
 options:
     resource_group:

plugins/modules/azure_rm_backuppolicy.py

@@ -86,15 +86,13 @@
     schedule_weekly_frequency:
         description:
             - The amount of weeks between backups.
-            - Backup every schedule_weekly_frequency week(s)
-            - Azure will default behavior to running weekly if this is left blank
-            - Backup every schedule_weekly_frequency week(s).
+            - Backup every I(schedule_weekly_frequency) week(s).
             - Azure will default behavior to running weekly if this is left blank.
             - Does not apply to Daily frequency.
         type: int
     time_zone:
         description:
-            - Timezone to apply schedule_run_time.
+            - Timezone to apply I(schedule_run_time).
         default: UTC
         type: str
 extends_documentation_fragment:

plugins/modules/azure_rm_privateendpointdnszonegroup_info.py

@@ -44,7 +44,7 @@
 '''
 
 EXAMPLES = '''
-- name: Get specific DNS zone groups for a private endpoing
+- name: Get specific DNS zone groups for a private endpoint
   azure_rm_privateendpointdnszonegroup_info:
     name: "my-zone-group"
     private_endpoint: "my-private-endpoint"

plugins/modules/azure_rm_snapshot.py

@@ -12,7 +12,7 @@
 ---
 module: azure_rm_snapshot
 version_added: "0.1.2"
-short_description: Manage Azure Snapshot instance.
+short_description: Manage Azure Snapshot instance
 description:
     - Create, update and delete instance of Azure Snapshot.
 options:
@@ -74,11 +74,11 @@
                     - Copy
             source_uri:
                 description:
-                    - If I(createOption=Import), this is the URI of a blob to be imported into a managed disk.
+                    - If I(create_option=Import), this is the URI of a blob to be imported into a managed disk.
                 type: str
             source_id:
                 description:
-                    - If I(createOption=Copy), this is the resource ID of a managed disk to be copied from.
+                    - If I(create_option=Copy), this is the resource ID of a managed disk to be copied from.
                 type: str
     state:
         description:

plugins/modules/azure_rm_sqlmanagedinstance.py

@@ -89,7 +89,7 @@
     administrator_login:
         description:
             - Administrator username for the managed instance.
-            -  Can only be specified when the managed instance is being created (and is required for creation).
+            - Can only be specified when the managed instance is being created (and is required for creation).
         type: str
     administrator_login_password:
         description:

plugins/modules/azure_rm_sqlmanagedinstance_info.py

@@ -14,7 +14,7 @@
 version_added: "0.15.0"
 short_description: Get Azure SQL managed instance facts
 description:
-    - Get facts of Azure SQL manged instance facts
+    - Get facts of Azure SQL manged instance facts.
 
 options:
     resource_group:

plugins/modules/azure_rm_sqlserver.py

@@ -68,7 +68,7 @@
         version_added: "1.11.0"
     change_admin_password:
         description:
-            - Whether or not the c(admin_password) should be updated for an existing server. If true, the password is the only value which will be updated.
+            - Whether or not the I(admin_password) should be updated for an existing server. If C(true), the password is the only value which will be updated.
         type: bool
         default: false
         version_added: "1.11.0"

plugins/modules/azure_rm_storageaccount_info.py

@@ -37,7 +37,7 @@
     show_connection_string:
         description:
             - Show the connection string for each of the storageaccount's endpoints.
-            - For convenient usage, C(show_connection_string) will also show the access keys for each of the storageaccount's endpoints.
+            - For convenient usage, I(show_connection_string) will also show the access keys for each of the storageaccount's endpoints.
             - Note that it will cost a lot of time when list all storageaccount rather than query a single one.
         type: bool
     show_blob_cors:

plugins/modules/azure_rm_storageshare_info.py

@@ -14,21 +14,21 @@
 version_added: "1.8.0"
 short_description: Get Azure storage file share info
 description:
-    - Get facts for storage file share
+    - Get facts for storage file share.
 options:
     resource_group:
         description:
-            - Name of the resource group to use
+            - Name of the resource group to use.
         required: true
         type: str
     name:
         description:
-            - Name of the storage file share
+            - Name of the storage file share.
         type: str
         required: false
     account_name:
         description:
-            - Name of the parent storage account for the storage file share
+            - Name of the parent storage account for the storage file share.
         required: true
         type: str
 

plugins/modules/azure_rm_virtualwan.py

@@ -68,7 +68,7 @@
         type: bool
     allow_vnet_to_vnet_traffic:
         description:
-            - True if Vnet to Vnet traffic is allowed.
+            - C(True) if Vnet to Vnet traffic is allowed.
         type: bool
     virtual_wan_type:
         description:

plugins/modules/azure_rm_webappaccessrestriction.py

@@ -69,7 +69,7 @@
     scm_ip_security_restrictions:
         description:
             - >-
-                The web app's SCM access restrictions. If C(scm_ip_security_restrictions_use_main) is set to C(true),
+                The web app's SCM access restrictions. If I(scm_ip_security_restrictions_use_main) is set to C(true),
                 the SCM restrictions will be configured but not used.
         type: list
         elements: dict
@@ -104,7 +104,7 @@
         description:
             - >-
                 Set to C(true) to have the HTTP access restrictions also apply to the SCM site.
-                If C(scm_ip_security_restrictions) are also applied, they will configured but not used.
+                If I(scm_ip_security_restrictions) are also applied, they will configured but not used.
         default: false
         type: bool