Skip to content

Commit

Permalink
grammatical fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
mikemorency committed Dec 11, 2024
1 parent 8b142d4 commit 7bd0ff2
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion plugins/doc_fragments/additional_rest_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ class ModuleDocFragment(object):
proxy_protocol:
description:
- The proxy connection protocol to use.
- This is option is used if the correct proxy protocol cannot be automatically determined.
- This option is used if the correct proxy protocol cannot be automatically determined.
type: str
choices: [ http, https ]
default: https
Expand Down
6 changes: 3 additions & 3 deletions plugins/doc_fragments/base_options.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class ModuleDocFragment(object):
# This vmware.vmware.base_options fragment covers the arg spec provided by the base_argument_spec() function
DOCUMENTATION = r'''
notes:
- All modules require API write access and hence is not supported on a free ESXi license.
- All modules require API write access and hence are not supported on a free ESXi license.
- All variables and VMware object names are case sensitive.
- >-
Modules may rely on the 'requests' python library, which does not use the system certificate store by default. You can
Expand Down Expand Up @@ -55,14 +55,14 @@ class ModuleDocFragment(object):
default: 443
proxy_host:
description:
- Address of a proxy that will receive all HTTPS requests and relay them.
- The address of a proxy that will receive all HTTPS requests and relay them.
- The format is a hostname or a IP.
- If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST) will be used instead.
type: str
required: false
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
- The port of the HTTP proxy that will receive all HTTPS requests and relay them.
- If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT) will be used instead.
type: int
required: false
Expand Down
6 changes: 3 additions & 3 deletions plugins/module_utils/_vmware_argument_spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
def rest_compatible_argument_spec():
"""
This returns a dictionary that can be used as the baseline for all REST module specs.
If your module uses the REST API, you should use this instead of the base_argument_spec.
If your module uses both this and the pyvmomi SDK, you should still use this spec.
If your module uses the REST API SDK, you should use this instead of the base_argument_spec.
If your module uses both the REST API SDK and the pyvmomi SDK, you should still use this spec.
"""
return {
**base_argument_spec(),
Expand All @@ -22,7 +22,7 @@ def rest_compatible_argument_spec():

def base_argument_spec():
"""
This returns a dictionary that can be used as the baseline for all vmware module specs. Any arguments
This returns a dictionary that can be used as the baseline for all VMware module specs. Any arguments
common to both the REST API SDK and pyvmomi SDK should be placed here.
If your module uses the REST API, you should use the rest_compatible_argument_spec since that
includes additional arguments specific to that SDK.
Expand Down

0 comments on commit 7bd0ff2

Please sign in to comment.