[PR #10398/717ef511 backport][stable-10] doc style adjustments: modules [efgh]* (#10402)

doc style adjustments: modules [efgh]* (#10398)

* doc style adjustments: modules e*

* doc style adjustments: modules f*

* doc style adjustments: modules g*

* doc style adjustments: modules h*

* Update plugins/modules/easy_install.py



---------


(cherry picked from commit 717ef51137)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>

plugins/modules/easy_install.py

@@ -33,8 +33,8 @@ options:
       - An optional O(virtualenv) directory path to install into. If the O(virtualenv) does not exist, it is created automatically.
   virtualenv_site_packages:
     description:
-      - Whether the virtual environment will inherit packages from the global site-packages directory. Note that if this setting
+      - Whether the virtual environment inherits packages from the global site-packages directory. Note that this setting
-        is changed on an already existing virtual environment it will not have any effect, the environment must be deleted
+        has no effect on an already existing virtual environment, so if you want to change it, the environment must be deleted
         and newly created.
     type: bool
     default: false

plugins/modules/elasticsearch_plugin.py

@@ -66,7 +66,7 @@ options:
     type: bool
   plugin_bin:
     description:
-      - Location of the plugin binary. If this file is not found, the default plugin binaries will be used.
+      - Location of the plugin binary. If this file is not found, the default plugin binaries are used.
     type: path
   plugin_dir:
     description:
@@ -83,7 +83,7 @@ options:
     type: str
   version:
     description:
-      - Version of the plugin to be installed. If plugin exists with previous version, it will NOT be updated.
+      - Version of the plugin to be installed. If plugin exists with previous version, it is NOT updated.
     type: str
 """
 

plugins/modules/emc_vnx_sg_member.py

@@ -77,7 +77,7 @@ EXAMPLES = r"""
 
 RETURN = r"""
 hluid:
-  description: LUNID that hosts attached to the storage group will see.
+  description: LUNID visible to hosts attached to the storage group.
   type: int
   returned: success
 """

plugins/modules/filesystem.py

@@ -64,10 +64,10 @@ options:
     description:
       - If V(true), if the block device and filesystem size differ, grow the filesystem into the space.
       - Supported for C(bcachefs), C(btrfs), C(ext2), C(ext3), C(ext4), C(ext4dev), C(f2fs), C(lvm), C(xfs), C(ufs) and C(vfat)
-        filesystems. Attempts to resize other filesystem types will fail.
+        filesystems. Attempts to resize other filesystem types fail.
-      - XFS Will only grow if mounted. Currently, the module is based on commands from C(util-linux) package to perform operations,
+      - XFS only grows if mounted. Currently, the module is based on commands from C(util-linux) package to perform operations,
         so resizing of XFS is not supported on FreeBSD systems.
-      - VFAT will likely fail if C(fatresize < 1.04).
+      - VFAT is likely to fail if C(fatresize < 1.04).
       - Mutually exclusive with O(uuid).
     type: bool
     default: false
@@ -82,7 +82,7 @@ options:
       - See xfs_admin(8) (C(xfs)), tune2fs(8) (C(ext2), C(ext3), C(ext4), C(ext4dev)) for possible values.
       - For O(fstype=lvm) the value is ignored, it resets the PV UUID if set.
       - Supported for O(fstype) being one of C(bcachefs), C(ext2), C(ext3), C(ext4), C(ext4dev), C(lvm), or C(xfs).
-      - This is B(not idempotent). Specifying this option will always result in a change.
+      - This is B(not idempotent). Specifying this option always results in a change.
       - Mutually exclusive with O(resizefs).
     type: str
     version_added: 7.1.0

plugins/modules/flatpak.py

@@ -27,7 +27,7 @@ attributes:
   check_mode:
     support: partial
     details:
-      - If O(state=latest), the module will always return C(changed=true).
+      - If O(state=latest), the module always returns RV(ignore:changed=true).
   diff_mode:
     support: none
 options:
@@ -53,7 +53,7 @@ options:
       - When supplying a reverse DNS name, you can use the O(remote) option to specify on what remote to look for the flatpak.
         An example for a reverse DNS name is C(org.gnome.gedit).
       - When used with O(state=absent) or O(state=latest), it is recommended to specify the name in the reverse DNS format.
-      - When supplying a URL with O(state=absent) or O(state=latest), the module will try to match the installed flatpak based
+      - When supplying a URL with O(state=absent) or O(state=latest), the module tries to match the installed flatpak based
         on the name of the flatpakref to remove or update it. However, there is no guarantee that the names of the flatpakref
         file and the reverse DNS name of the installed flatpak do match.
     type: list
@@ -171,26 +171,6 @@ command:
   returned: When a flatpak command has been executed
   type: str
   sample: "/usr/bin/flatpak install --user --nontinteractive flathub org.gnome.Calculator"
-msg:
-  description: Module error message.
-  returned: failure
-  type: str
-  sample: "Executable '/usr/local/bin/flatpak' was not found on the system."
-rc:
-  description: Return code from flatpak binary.
-  returned: When a flatpak command has been executed
-  type: int
-  sample: 0
-stderr:
-  description: Error output from flatpak binary.
-  returned: When a flatpak command has been executed
-  type: str
-  sample: "error: Error searching remote flathub: Can't find ref org.gnome.KDE"
-stdout:
-  description: Output from flatpak binary.
-  returned: When a flatpak command has been executed
-  type: str
-  sample: "org.gnome.Calendar/x86_64/stable\tcurrent\norg.gnome.gitg/x86_64/stable\tcurrent\n"
 """
 
 from ansible.module_utils.six.moves.urllib.parse import urlparse

plugins/modules/flatpak_remote.py

@@ -17,7 +17,7 @@ description:
   - Allows users to add or remove flatpak remotes.
   - The flatpak remotes concept is comparable to what is called repositories in other packaging formats.
   - Currently, remote addition is only supported using C(flatpakrepo) file URLs.
-  - Existing remotes will not be updated.
+  - Existing remotes are not updated.
   - See the M(community.general.flatpak) module for managing flatpaks.
 author:
   - John Kwiatkoski (@JayKayy)
@@ -56,8 +56,8 @@ options:
   name:
     description:
       - The desired name for the flatpak remote to be registered under on the managed host.
-      - When used with O(state=present), the remote will be added to the managed host under the specified O(name).
+      - When used with O(state=present), the remote is added to the managed host under the specified O(name).
-      - When used with O(state=absent) the remote with that name will be removed.
+      - When used with O(state=absent) the remote with that name is removed.
     type: str
     required: true
   state:

plugins/modules/gem.py

@@ -48,7 +48,7 @@ options:
   repository:
     type: str
     description:
-      - The repository from which the gem will be installed.
+      - The repository from which the gem is installed.
     required: false
     aliases: [source]
   user_install:
@@ -65,7 +65,7 @@ options:
   install_dir:
     type: path
     description:
-      - Install the gems into a specific directory. These gems will be independent from the global installed ones. Specifying
+      - Install the gems into a specific directory. These gems are independent from the global installed ones. Specifying
         this requires user_install to be false.
     required: false
   bindir:

plugins/modules/gio_mime.py

@@ -26,12 +26,12 @@ attributes:
 options:
   mime_type:
     description:
-      - MIME type for which a default handler will be set.
+      - MIME type for which a default handler is set.
     type: str
     required: true
   handler:
     description:
-      - Default handler will be set for the MIME type.
+      - Default handler set for the MIME type.
     type: str
     required: true
 notes:

plugins/modules/git_config_info.py

@@ -26,7 +26,7 @@ options:
   name:
     description:
       - The name of the setting to read.
-      - If not provided, all settings will be returned as RV(config_values).
+      - If not provided, all settings are returned as RV(config_values).
     type: str
   path:
     description:
@@ -94,8 +94,8 @@ config_values:
   description:
     - This is a dictionary mapping a git configuration setting to a list of its values.
     - When O(name) is not set, all configuration settings are returned here.
-    - When O(name) is set, only the setting specified in O(name) is returned here. If that setting is not set, the key will
+    - When O(name) is set, only the setting specified in O(name) is returned here. If that setting is not set, the key is
-      still be present, and its value will be an empty list.
+      still present, and its value is an empty list.
   returned: success
   type: dict
   sample:

plugins/modules/github_deploy_key.py

@@ -57,8 +57,8 @@ options:
     type: str
   read_only:
     description:
-      - If V(true), the deploy key will only be able to read repository contents. Otherwise, the deploy key will be able to
+      - If V(true), the deploy key is only able to read repository contents. Otherwise, the deploy key is able to read and
-        read and write.
+        write.
     type: bool
     default: true
   state:

plugins/modules/github_key.py

@@ -44,8 +44,8 @@ options:
     type: str
   force:
     description:
-      - The default is V(true), which will replace the existing remote key if it is different than O(pubkey). If V(false),
+      - The default is V(true), which replaces the existing remote key if it is different than O(pubkey). If V(false), the
-        the key will only be set if no key with the given O(name) exists.
+        key is only set if no key with the given O(name) exists.
     type: bool
     default: true
 

plugins/modules/github_repo.py

@@ -72,7 +72,7 @@ options:
   organization:
     description:
       - Organization for the repository.
-      - When O(state=present), the repository will be created in the current user profile.
+      - When O(state=present), the repository is created in the current user profile.
     type: str
     required: false
   api_url:

plugins/modules/github_webhook.py

@@ -32,7 +32,7 @@ options:
       - repo
   url:
     description:
-      - URL to which payloads will be delivered.
+      - URL to which payloads are delivered.
     type: str
     required: true
   content_type:

plugins/modules/gitlab_deploy_key.py

@@ -55,8 +55,8 @@ options:
     default: false
   state:
     description:
-      - When V(present) the deploy key added to the project if it does not exist.
+      - When V(present) the deploy key is added to the project if it does not exist.
-      - When V(absent) it will be removed from the project if it exists.
+      - When V(absent) it is removed from the project if it exists.
     default: present
     type: str
     choices: ["present", "absent"]

plugins/modules/gitlab_group.py

@@ -13,8 +13,8 @@ DOCUMENTATION = r"""
 module: gitlab_group
 short_description: Creates/updates/deletes GitLab Groups
 description:
-  - When the group does not exist in GitLab, it will be created.
+  - When the group does not exist in GitLab, it is created.
-  - When the group does exist and state=absent, the group will be deleted.
+  - When the group does exist and O(state=absent), the group is deleted.
 author:
   - Werner Dijkerman (@dj-wasabi)
   - Guillaume Martinez (@Lunik)
@@ -101,8 +101,8 @@ options:
     type: str
   path:
     description:
-      - The path of the group you want to create, this will be api_url/group_path.
+      - The path of the group you want to create, this is O(api_url)/O(path).
-      - If not supplied, the group_name will be used.
+      - If not supplied, O(name) is used.
     type: str
   prevent_forking_outside_group:
     description:
@@ -129,7 +129,7 @@ options:
   service_access_tokens_expiration_enforced:
     description:
       - Service account token expiration.
-      - Changes will not affect existing token expiration dates.
+      - Changes do not affect existing token expiration dates.
       - Only available for top level groups.
     type: bool
     version_added: 9.5.0

plugins/modules/gitlab_group_access_token.py

@@ -28,7 +28,7 @@ extends_documentation_fragment:
   - community.general.attributes
 notes:
   - Access tokens can not be changed. If a parameter needs to be changed, an acceess token has to be recreated. Whether tokens
-    will be recreated is controlled by the O(recreate) option, which defaults to V(never).
+    are recreated or not is controlled by the O(recreate) option, which defaults to V(never).
   - Token string is contained in the result only when access token is created or recreated. It can not be fetched afterwards.
   - Token matching is done by comparing O(name) option.
 attributes:
@@ -79,17 +79,17 @@ options:
     required: true
   recreate:
     description:
-      - Whether the access token will be recreated if it already exists.
+      - Whether the access token is recreated if it already exists.
-      - When V(never) the token will never be recreated.
+      - When V(never) the token is never recreated.
-      - When V(always) the token will always be recreated.
+      - When V(always) the token is always recreated.
-      - When V(state_change) the token will be recreated if there is a difference between desired state and actual state.
+      - When V(state_change) the token is recreated if there is a difference between desired state and actual state.
     type: str
     choices: ["never", "always", "state_change"]
     default: never
   state:
     description:
-      - When V(present) the access token will be added to the group if it does not exist.
+      - When V(present) the access token is added to the group if it does not exist.
-      - When V(absent) it will be removed from the group if it exists.
+      - When V(absent) it is removed from the group if it exists.
     default: present
     type: str
     choices: ["present", "absent"]

plugins/modules/gitlab_group_variable.py

@@ -15,9 +15,9 @@ short_description: Creates, updates, or deletes GitLab groups variables
 version_added: 1.2.0
 description:
   - Creates a group variable if it does not exist.
-  - When a group variable does exist, its value will be updated when the values are different.
+  - When a group variable does exist, its value is updated when the values are different.
   - Variables which are untouched in the playbook, but are not untouched in the GitLab group, they stay untouched (O(purge=false))
-    or will be deleted (O(purge=true)).
+    or are deleted (O(purge=true)).
 author:
   - Florent Madiot (@scodeman)
 requirements:
@@ -52,7 +52,7 @@ options:
     type: bool
   vars:
     description:
-      - When the list element is a simple key-value pair, masked, raw and protected will be set to false.
+      - When the list element is a simple key-value pair, masked, raw and protected are set to V(false).
       - When the list element is a dict with the keys C(value), C(masked), C(raw) and C(protected), the user can have full
         control about whether a value should be masked, raw, protected or both.
       - Support for group variables requires GitLab >= 9.5.
@@ -185,22 +185,22 @@ group_variable:
       description: A list of variables which were created.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
     untouched:
       description: A list of variables which exist.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
     removed:
       description: A list of variables which were deleted.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
     updated:
       description: A list of variables whose values were changed.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
 """
 
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/gitlab_hook.py

@@ -45,8 +45,8 @@ options:
     type: str
   state:
     description:
-      - When V(present) the hook will be updated to match the input or created if it does not exist.
+      - When V(present) the hook is updated to match the input or created if it does not exist.
-      - When V(absent) hook will be deleted if it exists.
+      - When V(absent) hook is deleted if it exists.
     default: present
     type: str
     choices: ["present", "absent"]
@@ -103,15 +103,15 @@ options:
     version_added: '8.4.0'
   hook_validate_certs:
     description:
-      - Whether GitLab will do SSL verification when triggering the hook.
+      - Whether GitLab performs SSL verification when triggering the hook.
     type: bool
     default: false
     aliases: [enable_ssl_verification]
   token:
     description:
       - Secret token to validate hook messages at the receiver.
-      - If this is present it will always result in a change as it cannot be retrieved from GitLab.
+      - If this is present it always results in a change as it cannot be retrieved from GitLab.
-      - Will show up in the X-GitLab-Token HTTP request header.
+      - It shows up in the C(X-GitLab-Token) HTTP request header.
     required: false
     type: str
 """

plugins/modules/gitlab_instance_variable.py

@@ -16,10 +16,10 @@ short_description: Creates, updates, or deletes GitLab instance variables
 version_added: 7.1.0
 description:
   - Creates a instance variable if it does not exist.
-  - When a instance variable does exist, its value will be updated if the values are different.
+  - When a instance variable does exist, its value is updated if the values are different.
   - Support for instance variables requires GitLab >= 13.0.
-  - Variables which are not mentioned in the modules options, but are present on the GitLab instance, will either stay (O(purge=false))
+  - Variables which are not mentioned in the modules options, but are present on the GitLab instance, either stay (O(purge=false))
-    or will be deleted (O(purge=true)).
+    or are deleted (O(purge=true)).
 author:
   - Benedikt Braunger (@benibr)
 requirements:
@@ -124,22 +124,22 @@ instance_variable:
       description: A list of variables which were created.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
     untouched:
       description: A list of variables which exist.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
     removed:
       description: A list of variables which were deleted.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
     updated:
       description: A list pre-existing variables whose values have been set.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
 """
 
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/gitlab_issue.py

@@ -18,8 +18,8 @@ short_description: Create, update, or delete GitLab issues
 version_added: '8.1.0'
 description:
   - Creates an issue if it does not exist.
-  - When an issue does exist, it will be updated if the provided parameters are different.
+  - When an issue does exist, it is updated if the provided parameters are different.
-  - When an issue does exist and O(state=absent), the issue will be deleted.
+  - When an issue does exist and O(state=absent), the issue is deleted.
   - When multiple issues are detected, the task fails.
   - Existing issues are matched based on O(title) and O(state_filter) filters.
 author:

plugins/modules/gitlab_label.py

@@ -12,8 +12,8 @@ module: gitlab_label
 short_description: Creates/updates/deletes GitLab Labels belonging to project or group
 version_added: 8.3.0
 description:
-  - When a label does not exist, it will be created.
+  - When a label does not exist, it is created.
-  - When a label does exist, its value will be updated when the values are different.
+  - When a label does exist, its value is updated when the values are different.
   - Labels can be purged.
 author:
   - "Gabriele Pongelli (@gpongelli)"
@@ -197,22 +197,22 @@ labels:
       description: A list of labels which were created.
       returned: always
       type: list
-      sample: ['abcd', 'label-one']
+      sample: ["abcd", "label-one"]
     untouched:
       description: A list of labels which exist.
       returned: always
       type: list
-      sample: ['defg', 'new-label']
+      sample: ["defg", "new-label"]
     removed:
       description: A list of labels which were deleted.
       returned: always
       type: list
-      sample: ['defg', 'new-label']
+      sample: ["defg", "new-label"]
     updated:
       description: A list pre-existing labels whose values have been set.
       returned: always
       type: list
-      sample: ['defg', 'new-label']
+      sample: ["defg", "new-label"]
 labels_obj:
   description: API object.
   returned: success

plugins/modules/gitlab_merge_request.py

@@ -18,8 +18,8 @@ short_description: Create, update, or delete GitLab merge requests
 version_added: 7.1.0
 description:
   - Creates a merge request if it does not exist.
-  - When a single merge request does exist, it will be updated if the provided parameters are different.
+  - When a single merge request does exist, it is updated if the provided parameters are different.
-  - When a single merge request does exist and O(state=absent), the merge request will be deleted.
+  - When a single merge request does exist and O(state=absent), the merge request is deleted.
   - When multiple merge requests are detected, the task fails.
   - Existing merge requests are matched based on O(title), O(source_branch), O(target_branch), and O(state_filter) filters.
 author:

plugins/modules/gitlab_milestone.py

@@ -12,8 +12,8 @@ module: gitlab_milestone
 short_description: Creates/updates/deletes GitLab Milestones belonging to project or group
 version_added: 8.3.0
 description:
-  - When a milestone does not exist, it will be created.
+  - When a milestone does not exist, it is created.
-  - When a milestone does exist, its value will be updated when the values are different.
+  - When a milestone does exist, its value is updated when the values are different.
   - Milestones can be purged.
 author:
   - "Gabriele Pongelli (@gpongelli)"
@@ -181,22 +181,22 @@ milestones:
       description: A list of milestones which were created.
       returned: always
       type: list
-      sample: ['abcd', 'milestone-one']
+      sample: ["abcd", "milestone-one"]
     untouched:
       description: A list of milestones which exist.
       returned: always
       type: list
-      sample: ['defg', 'new-milestone']
+      sample: ["defg", "new-milestone"]
     removed:
       description: A list of milestones which were deleted.
       returned: always
       type: list
-      sample: ['defg', 'new-milestone']
+      sample: ["defg", "new-milestone"]
     updated:
       description: A list pre-existing milestones whose values have been set.
       returned: always
       type: list
-      sample: ['defg', 'new-milestone']
+      sample: ["defg", "new-milestone"]
 milestones_obj:
   description: API object.
   returned: success

plugins/modules/gitlab_project.py

@@ -13,9 +13,9 @@ DOCUMENTATION = r"""
 module: gitlab_project
 short_description: Creates/updates/deletes GitLab Projects
 description:
-  - When the project does not exist in GitLab, it will be created.
+  - When the project does not exist in GitLab, it is created.
-  - When the project does exist and O(state=absent), the project will be deleted.
+  - When the project does exist and O(state=absent), the project is deleted.
-  - When changes are made to the project, the project will be updated.
+  - When changes are made to the project, the project is updated.
 author:
   - Werner Dijkerman (@dj-wasabi)
   - Guillaume Martinez (@Lunik)
@@ -47,7 +47,7 @@ options:
   build_timeout:
     description:
       - Maximum number of seconds a CI job can run.
-      - If not specified on creation, GitLab will impose a default value.
+      - If not specified on creation, GitLab imposes a default value.
     type: int
     version_added: "10.6.0"
   builds_access_level:
@@ -148,7 +148,7 @@ options:
     type: str
   import_url:
     description:
-      - Git repository which will be imported into gitlab.
+      - Git repository which is imported into gitlab.
       - GitLab server needs read access to this git repository.
     required: false
     type: str
@@ -162,7 +162,7 @@ options:
     version_added: "6.4.0"
   initialize_with_readme:
     description:
-      - Will initialize the project with a default C(README.md).
+      - Initializes the project with a default C(README.md).
       - Is only used when the project is created, and ignored otherwise.
     type: bool
     default: false
@@ -248,8 +248,8 @@ options:
     version_added: "9.3.0"
   path:
     description:
-      - The path of the project you want to create, this will be server_url/<group>/path.
+      - The path of the project you want to create, this is server_url/O(group)/O(path).
-      - If not supplied, name will be used.
+      - If not supplied, O(name) is used.
     type: str
   releases_access_level:
     description:

plugins/modules/gitlab_project_access_token.py

@@ -28,7 +28,7 @@ extends_documentation_fragment:
   - community.general.attributes
 notes:
   - Access tokens can not be changed. If a parameter needs to be changed, an acceess token has to be recreated. Whether tokens
-    will be recreated is controlled by the O(recreate) option, which defaults to V(never).
+    are recreated or not is controlled by the O(recreate) option, which defaults to V(never).
   - Token string is contained in the result only when access token is created or recreated. It can not be fetched afterwards.
   - Token matching is done by comparing O(name) option.
 attributes:
@@ -79,17 +79,17 @@ options:
     required: true
   recreate:
     description:
-      - Whether the access token will be recreated if it already exists.
+      - Whether the access token is recreated if it already exists.
-      - When V(never) the token will never be recreated.
+      - When V(never) the token is never recreated.
-      - When V(always) the token will always be recreated.
+      - When V(always) the token is always recreated.
-      - When V(state_change) the token will be recreated if there is a difference between desired state and actual state.
+      - When V(state_change) the token is recreated if there is a difference between desired state and actual state.
     type: str
     choices: ["never", "always", "state_change"]
     default: never
   state:
     description:
-      - When V(present) the access token will be added to the project if it does not exist.
+      - When V(present) the access token is added to the project if it does not exist.
-      - When V(absent) it will be removed from the project if it exists.
+      - When V(absent) it is removed from the project if it exists.
     default: present
     type: str
     choices: ["present", "absent"]

plugins/modules/gitlab_project_variable.py

@@ -11,10 +11,10 @@ DOCUMENTATION = r"""
 module: gitlab_project_variable
 short_description: Creates/updates/deletes GitLab Projects Variables
 description:
-  - When a project variable does not exist, it will be created.
+  - When a project variable does not exist, it is created.
-  - When a project variable does exist, its value will be updated when the values are different.
+  - When a project variable does exist, its value is updated when the values are different.
   - Variables which are untouched in the playbook, but are not untouched in the GitLab project, they stay untouched (O(purge=false))
-    or will be deleted (O(purge=true)).
+    or are deleted (O(purge=true)).
 author:
   - "Markus Bergholz (@markuman)"
 requirements:
@@ -45,12 +45,12 @@ options:
     type: str
   purge:
     description:
-      - When set to true, all variables which are not untouched in the task will be deleted.
+      - When set to V(true), all variables which are not untouched in the task are deleted.
     default: false
     type: bool
   vars:
     description:
-      - When the list element is a simple key-value pair, masked, raw and protected will be set to false.
+      - When the list element is a simple key-value pair, masked, raw and protected are set to V(false).
       - When the list element is a dict with the keys C(value), C(masked), C(raw) and C(protected), the user can have full
         control about whether a value should be masked, raw, protected or both.
       - Support for protected values requires GitLab >= 9.3.
@@ -202,22 +202,22 @@ project_variable:
       description: A list of variables which were created.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
     untouched:
       description: A list of variables which exist.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
     removed:
       description: A list of variables which were deleted.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
     updated:
       description: A list of variables whose values were changed.
       returned: always
       type: list
-      sample: ['ACCESS_KEY_ID', 'SECRET_ACCESS_KEY']
+      sample: ["ACCESS_KEY_ID", "SECRET_ACCESS_KEY"]
 """
 
 from ansible.module_utils.basic import AnsibleModule

plugins/modules/gitlab_runner.py

@@ -81,8 +81,8 @@ options:
     description:
       - The registration token is used to register new runners before GitLab 16.0.
       - Required if O(state=present) for GitLab < 16.0.
-      - If set, the runner will be created using the old runner creation workflow.
+      - If set, the runner is created using the old runner creation workflow.
-      - If not set, the runner will be created using the new runner creation workflow, introduced in GitLab 16.0.
+      - If not set, the runner is created using the new runner creation workflow, introduced in GitLab 16.0.
       - If not set, requires python-gitlab >= 4.0.0.
     type: str
   owned:
@@ -122,8 +122,8 @@ options:
       - If set to V(not_protected), runner can pick up jobs from both protected and unprotected branches.
       - If set to V(ref_protected), runner can pick up jobs only from protected branches.
       - Before community.general 8.0.0 the default was V(ref_protected). This was changed to no default in community.general
-        8.0.0. If this option is not specified explicitly, GitLab will use V(not_protected) on creation, and the value set
+        8.0.0. If this option is not specified explicitly, GitLab uses V(not_protected) on creation, and the value set is
-        will not be changed on any updates.
+        not changed on any updates.
     required: false
     choices: ["not_protected", "ref_protected"]
     type: str

plugins/modules/gitlab_user.py

@@ -14,10 +14,10 @@ DOCUMENTATION = r"""
 module: gitlab_user
 short_description: Creates/updates/deletes/blocks/unblocks GitLab Users
 description:
-  - When the user does not exist in GitLab, it will be created.
+  - When the user does not exist in GitLab, it is created.
-  - When the user exists and state=absent, the user will be deleted.
+  - When the user exists and state=absent, the user is deleted.
-  - When the user exists and state=blocked, the user will be blocked.
+  - When the user exists and state=blocked, the user is blocked.
-  - When changes are made to user, the user will be updated.
+  - When changes are made to user, the user is updated.
 notes:
   - From community.general 0.2.0 and onwards, name, email and password are optional while deleting the user.
 author:

plugins/modules/grove.py

@@ -51,8 +51,8 @@ options:
     required: false
   validate_certs:
     description:
-      - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
+      - If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
-        self-signed certificates.
+        certificates.
     default: true
     type: bool
 author: "Jonas Pfenniger (@zimbatm)"

plugins/modules/gunicorn.py

@@ -50,8 +50,8 @@ options:
   pid:
     type: path
     description:
-      - A filename to use for the PID file. If not set and not found on the configuration file a tmp pid file will be created
+      - A filename to use for the PID file. If not set and not found on the configuration file a tmp pid file is created to
-        to check a successful run of gunicorn.
+        check a successful run of gunicorn.
   worker:
     type: str
     choices: ['sync', 'eventlet', 'gevent', 'tornado ', 'gthread', 'gaiohttp']
@@ -62,8 +62,8 @@ options:
     description:
       - Switch worker processes to run as this user.
 notes:
-  - If not specified on config file, a temporary error log will be created on /tmp dir. Please make sure you have write access
+  - If not specified on config file, a temporary error log is created on C(/tmp) directory. Please make sure you have write
-    in /tmp dir. Not needed but will help you to identify any problem with configuration.
+    access in C(/tmp) directory. Not needed but it is helpful to identify any problem with configuration.
 """
 
 EXAMPLES = r"""

plugins/modules/haproxy.py

@@ -32,7 +32,7 @@ options:
   backend:
     description:
       - Name of the HAProxy backend pool.
-      - If this parameter is unset, it will be auto-detected.
+      - If this parameter is unset, it is auto-detected.
     type: str
   drain:
     description:
@@ -62,8 +62,7 @@ options:
   state:
     description:
       - Desired state of the provided backend host.
-      - Note that V(drain) state is supported only by HAProxy version 1.5 or later. When used on versions < 1.5, it will be
+      - Note that V(drain) state is supported only by HAProxy version 1.5 or later. When used on versions < 1.5, it is ignored.
-        ignored.
     type: str
     required: true
     choices: [disabled, drain, enabled]
@@ -103,7 +102,7 @@ options:
   weight:
     description:
       - The value passed in argument.
-      - If the value ends with the V(%) sign, then the new weight will be relative to the initially configured weight.
+      - If the value ends with the V(%) sign, then the new weight is relative to the initially configured weight.
       - Relative weights are only permitted between 0 and 100% and absolute weights are permitted between 0 and 256.
     type: str
 """

plugins/modules/hg.py

@@ -61,15 +61,15 @@ options:
     default: true
   executable:
     description:
-      - Path to hg executable to use. If not supplied, the normal mechanism for resolving binary paths will be used.
+      - Path to C(hg) executable to use. If not supplied, the normal mechanism for resolving binary paths is used.
     type: str
 notes:
   - This module does not support push capability. See U(https://github.com/ansible/ansible/issues/31156).
-  - 'If the task seems to be hanging, first verify remote host is in C(known_hosts). SSH will prompt user to authorize the
+  - 'If the task seems to be hanging, first verify remote host is in C(known_hosts). SSH prompts user to authorize the first
-    first contact with a remote host. To avoid this prompt, one solution is to add the remote host public key in C(/etc/ssh/ssh_known_hosts)
+    contact with a remote host. To avoid this prompt, one solution is to add the remote host public key in C(/etc/ssh/ssh_known_hosts)
     before calling the hg module, with the following command: C(ssh-keyscan remote_host.com >> /etc/ssh/ssh_known_hosts).'
   - As per 01 Dec 2018, Bitbucket has dropped support for TLSv1 and TLSv1.1 connections. As such, if the underlying system
-    still uses a Python version below 2.7.9, you will have issues checking out bitbucket repositories. See
+    still uses a Python version below 2.7.9, you are bound to have issues checking out bitbucket repositories. See
     U(https://bitbucket.org/blog/deprecating-tlsv1-tlsv1-1-2018-12-01).
 """
 

plugins/modules/homebrew.py

@@ -83,7 +83,7 @@ options:
     default: false
     version_added: 9.0.0
 notes:
-  - When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly
+  - When used with a C(loop:) each package is processed individually, it is much more efficient to pass the list directly
     to the O(name) option.
 """
 
@@ -173,7 +173,7 @@ changed_pkgs:
     - List of package names which are changed after module run.
   returned: success
   type: list
-  sample: ['git', 'git-cola']
+  sample: ["git", "git-cola"]
   version_added: '0.2.0'
 """
 

plugins/modules/homectl.py

@@ -65,7 +65,7 @@ options:
     type: str
   resize:
     description:
-      - When used with O(disksize) this will attempt to resize the home directory immediately.
+      - When used with O(disksize) this attempts to resize the home directory immediately.
     default: false
     type: bool
   realname:

plugins/modules/honeybadger_deployment.py

@@ -51,7 +51,7 @@ options:
     default: "https://api.honeybadger.io/v1/deploys"
   validate_certs:
     description:
-      - If V(false), SSL certificates for the target URL will not be validated. This should only be used on personally controlled
+      - If V(false), SSL certificates for the target URL are not validated. This should only be used on personally controlled
         sites using self-signed certificates.
     type: bool
     default: true

plugins/modules/hpilo_boot.py

@@ -67,7 +67,7 @@ options:
   force:
     description:
       - Whether to force a reboot (even when the system is already booted).
-      - As a safeguard, without force, hpilo_boot will refuse to reboot a server that is already running.
+      - As a safeguard, without force, M(community.general.hpilo_boot) refuses to reboot a server that is already running.
     default: false
     type: bool
   ssl_version:
@@ -78,7 +78,7 @@ options:
     choices: ["SSLv3", "SSLv23", "TLSv1", "TLSv1_1", "TLSv1_2"]
   idempotent_boot_once:
     description:
-      - "This option makes O(state=boot_once) succeed instead of failing when the server is already powered on."
+      - This option makes O(state=boot_once) succeed instead of failing when the server is already powered on.
     type: bool
     default: false
     version_added: 10.6.0

plugins/modules/hpilo_info.py

@@ -121,7 +121,7 @@ hw_uuid:
 host_power_status:
   description:
     - Power status of host.
-    - Will be one of V(ON), V(OFF) and V(UNKNOWN).
+    - It is one of V(ON), V(OFF) and V(UNKNOWN).
   returned: always
   type: str
   sample: "ON"

plugins/modules/hwc_ecs_instance.py

@@ -442,7 +442,7 @@ created:
 disk_config_type:
   description:
     - Specifies the disk configuration type. MANUAL is The image space is not expanded. AUTO is the image space of the system
-      disk will be expanded to be as same as the flavor.
+      disk is expanded to be as same as the flavor.
   type: str
   returned: success
 host_name:

plugins/modules/hwc_evs_disk.py

@@ -70,8 +70,8 @@ options:
       - SSD specifies the ultra-high I/O disk type.
       - SAS specifies the high I/O disk type.
       - SATA specifies the common I/O disk type.
-      - If the specified disk type is not available in the AZ, the disk will fail to create. If the EVS disk is created from
+      - If the specified disk type is not available in the AZ, the disk creation fails. If the EVS disk is created from a
-        a snapshot, the volume_type field must be the same as that of the snapshot's source disk.
+        snapshot, the volume_type field must be the same as that of the snapshot's source disk.
     type: str
     required: true
   backup_id:
@@ -92,9 +92,9 @@ options:
     required: false
   enable_scsi:
     description:
-      - If this parameter is set to True, the disk device type will be SCSI, which allows ECS OSs to directly access underlying
+      - If this parameter is set to V(true), the disk device type is SCSI, which allows ECS OSs to directly access underlying
-        storage media. SCSI reservation command is supported. If this parameter is set to False, the disk device type will
+        storage media. SCSI reservation command is supported. If this parameter is set to V(false), the disk device type is
-        be VBD, which supports only simple SCSI read/write commands.
+        VBD, which supports only simple SCSI read/write commands.
       - If parameter enable_share is set to True and this parameter is not specified, shared SCSI disks are created. SCSI
         EVS disks cannot be created from backups, which means that this parameter cannot be True if backup_id has been specified.
     type: bool
@@ -167,8 +167,8 @@ volume_type:
     - SSD specifies the ultra-high I/O disk type.
     - SAS specifies the high I/O disk type.
     - SATA specifies the common I/O disk type.
-    - If the specified disk type is not available in the AZ, the disk will fail to create. If the EVS disk is created from
+    - If the specified disk type is not available in the AZ, the disk creation fails. If the EVS disk is created from a snapshot,
-      a snapshot, the volume_type field must be the same as that of the snapshot's source disk.
+      the volume_type field must be the same as that of the snapshot's source disk.
   type: str
   returned: success
 backup_id:
@@ -189,8 +189,8 @@ enable_full_clone:
   returned: success
 enable_scsi:
   description:
-    - If this parameter is set to True, the disk device type will be SCSI, which allows ECS OSs to directly access underlying
+    - If this parameter is set to V(true), the disk device type is SCSI, which allows ECS OSs to directly access underlying
-      storage media. SCSI reservation command is supported. If this parameter is set to False, the disk device type will be
+      storage media. SCSI reservation command is supported. If this parameter is set to V(false), the disk device type is
       VBD, which supports only simple SCSI read/write commands.
     - If parameter enable_share is set to True and this parameter is not specified, shared SCSI disks are created. SCSI EVS
       disks cannot be created from backups, which means that this parameter cannot be True if backup_id has been specified.

plugins/modules/hwc_network_vpc.py

@@ -117,7 +117,7 @@ routes:
       returned: success
     next_hop:
       description:
-        - The next hop of a route. If the route type is peering, it will provide VPC peering connection ID.
+        - The next hop of a route. If the route type is peering, it provides VPC peering connection ID.
       type: str
       returned: success
 enable_shared_snat:

plugins/modules/hwc_vpc_eip.py

@@ -92,7 +92,7 @@ options:
     required: false
   ip_version:
     description:
-      - The value can be 4 (IPv4 address) or 6 (IPv6 address). If this parameter is left blank, an IPv4 address will be assigned.
+      - The value can be 4 (IPv4 address) or 6 (IPv6 address). If this parameter is left blank, an IPv4 address is assigned.
     type: int
     required: false
   ipv4_address:
@@ -193,7 +193,7 @@ enterprise_project_id:
   returned: success
 ip_version:
   description:
-    - The value can be 4 (IPv4 address) or 6 (IPv6 address). If this parameter is left blank, an IPv4 address will be assigned.
+    - The value can be 4 (IPv4 address) or 6 (IPv6 address). If this parameter is left blank, an IPv4 address is assigned.
   type: int
   returned: success
 ipv4_address:

plugins/modules/hwc_vpc_private_ip.py

@@ -21,7 +21,7 @@ notes:
   - If O(id) option is provided, it takes precedence over O(subnet_id), O(ip_address) for private IP selection.
   - O(subnet_id), O(ip_address) are used for private IP selection. If more than one private IP with this options exists, execution
     is aborted.
-  - No parameter support updating. If one of option is changed, the module will create a new resource.
+  - No parameter support updating. If one of option is changed, the module creates a new resource.
 version_added: '0.2.0'
 author: Huawei Inc. (@huaweicloud)
 requirements:

plugins/modules/hwc_vpc_route.py

@@ -21,7 +21,7 @@ notes:
   - If O(id) option is provided, it takes precedence over O(destination), O(vpc_id), O(type), and O(next_hop) for route selection.
   - O(destination), O(vpc_id), O(type) and O(next_hop) are used for route selection. If more than one route with this options
     exists, execution is aborted.
-  - No parameter support updating. If one of option is changed, the module will create a new resource.
+  - No parameter support updating. If one of option is changed, the module creates a new resource.
 version_added: '0.2.0'
 author: Huawei Inc. (@huaweicloud)
 requirements:

plugins/modules/hwc_vpc_security_group.py

@@ -22,7 +22,7 @@ notes:
     selection.
   - O(name), O(enterprise_project_id) and O(vpc_id) are used for security group selection. If more than one security group
     with this options exists, execution is aborted.
-  - No parameter support updating. If one of option is changed, the module will create a new resource.
+  - No parameter support updating. If one of option is changed, the module creates a new resource.
 version_added: '0.2.0'
 author: Huawei Inc. (@huaweicloud)
 requirements:

plugins/modules/hwc_vpc_security_group_rule.py

@@ -21,7 +21,7 @@ notes:
   - If O(id) option is provided, it takes precedence over O(security_group_id) for security group rule selection.
   - O(security_group_id) is used for security group rule selection. If more than one security group rule with this options
     exists, execution is aborted.
-  - No parameter support updating. If one of option is changed, the module will create a new resource.
+  - No parameter support updating. If one of option is changed, the module creates a new resource.
 version_added: '0.2.0'
 author: Huawei Inc. (@huaweicloud)
 requirements:

plugins/modules/hwc_vpc_subnet.py

@@ -86,7 +86,7 @@ options:
     required: false
   dns_address:
     description:
-      - Specifies the DNS server addresses for subnet. The address in the head will be used first.
+      - Specifies the DNS server addresses for subnet. The address in the head is used first.
     type: list
     elements: str
     required: false
@@ -148,7 +148,7 @@ dhcp_enable:
   returned: success
 dns_address:
   description:
-    - Specifies the DNS server addresses for subnet. The address in the head will be used first.
+    - Specifies the DNS server addresses for subnet. The address in the head is used first.
   type: list
   returned: success
 """