Skip to content

Commit

Permalink
fixing typos in module documentation (#541)
Browse files Browse the repository at this point in the history
SUMMARY
Fixes some grammatical errors in the vcenter_rest_log_file parameter description.
Also fixes some typos and spacing issues in the customization module documentation
ISSUE TYPE

Docs Pull Request

COMPONENT NAME

vcenter_vm_guest_customization
vcenter_rest_log_file param

Reviewed-by: Anna Savina
  • Loading branch information
mikemorency authored Oct 15, 2024
1 parent 30fa49c commit 3958614
Show file tree
Hide file tree
Showing 135 changed files with 216 additions and 212 deletions.
4 changes: 4 additions & 0 deletions changelogs/fragments/540-typo-fixes-in-module-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
bugfixes:
- vcenter_vm_guest_customization - Fixed typos and spacing in the module examples
- Fixed grammatical error in vcenter_rest_log_file parameter description
2 changes: 1 addition & 1 deletion plugins/modules/appliance_access_consolecli.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_access_consolecli_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_access_dcui.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_access_dcui_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_access_shell.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_access_shell_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_access_ssh.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_access_ssh_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_health_applmgmt_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_health_database_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_health_databasestorage_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_health_load_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_health_mem_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_health_softwarepackages_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_health_storage_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_health_swap_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_health_system_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_infraprofile_configs.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_infraprofile_configs_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_localaccounts_globalpolicy.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_localaccounts_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_monitoring_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_monitoring_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_dns_domains.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_dns_domains_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_dns_hostname.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_dns_hostname_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_dns_servers.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_dns_servers_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_firewall_inbound.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_interfaces_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_interfaces_ipv4.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/appliance_networking_interfaces_ipv6.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
description:
- 'You can use this optional parameter to set the location of a log file. '
- 'This file will be used to record the HTTP REST interaction. '
- 'The file will be stored on the host that run the module. '
- 'The file will be stored on the host that runs the module. '
- 'If the value is not specified in the task, the value of '
- environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
type: str
Expand Down
Loading

0 comments on commit 3958614

Please sign in to comment.