From 6e011f00f4e3cfa8f7bb11530ae7f7442f1d2549 Mon Sep 17 00:00:00 2001 From: Alexei Znamensky <103110+russoz@users.noreply.github.com> Date: Mon, 5 Sep 2022 01:25:34 +1200 Subject: [PATCH] multiple modules: fixed markups in doc (#5227) --- plugins/modules/packaging/language/composer.py | 2 +- plugins/modules/packaging/os/layman.py | 2 +- plugins/modules/packaging/os/pacman.py | 6 +++--- plugins/modules/packaging/os/pkgng.py | 4 ++-- plugins/modules/packaging/os/pkgutil.py | 2 +- plugins/modules/packaging/os/sorcery.py | 2 +- plugins/modules/packaging/os/svr4pkg.py | 4 ++-- plugins/modules/packaging/os/zypper.py | 2 +- plugins/modules/remote_management/cobbler/cobbler_system.py | 4 ++-- plugins/modules/source_control/github/github_key.py | 4 ++-- plugins/modules/system/dconf.py | 2 +- plugins/modules/system/open_iscsi.py | 2 +- plugins/modules/system/osx_defaults.py | 2 +- plugins/modules/web_infrastructure/htpasswd.py | 2 +- 14 files changed, 20 insertions(+), 20 deletions(-) diff --git a/plugins/modules/packaging/language/composer.py b/plugins/modules/packaging/language/composer.py index fbc5ba3f01..64310c760e 100644 --- a/plugins/modules/packaging/language/composer.py +++ b/plugins/modules/packaging/language/composer.py @@ -41,7 +41,7 @@ options: description: - Directory of your project (see --working-dir). This is required when the command is not run globally. - - Will be ignored if C(global_command=true). + - Will be ignored if I(global_command=true). global_command: description: - Runs the specified command globally. diff --git a/plugins/modules/packaging/os/layman.py b/plugins/modules/packaging/os/layman.py index 1b50ae48cd..b860385969 100644 --- a/plugins/modules/packaging/os/layman.py +++ b/plugins/modules/packaging/os/layman.py @@ -25,7 +25,7 @@ options: name: description: - The overlay id to install, synchronize, or uninstall. - Use 'ALL' to sync all of the installed overlays (can be used only when C(state=updated)). + Use 'ALL' to sync all of the installed overlays (can be used only when I(state=updated)). required: true type: str list_url: diff --git a/plugins/modules/packaging/os/pacman.py b/plugins/modules/packaging/os/pacman.py index a1e0daf455..c8d6caebe5 100644 --- a/plugins/modules/packaging/os/pacman.py +++ b/plugins/modules/packaging/os/pacman.py @@ -45,9 +45,9 @@ options: force: description: - When removing packages, forcefully remove them, without any checks. - Same as C(extra_args="--nodeps --nodeps"). + Same as I(extra_args="--nodeps --nodeps"). When combined with I(update_cache), force a refresh of all package databases. - Same as C(update_cache_extra_args="--refresh --refresh"). + Same as I(update_cache_extra_args="--refresh --refresh"). default: false type: bool @@ -115,7 +115,7 @@ options: reason_for: description: - Set the install reason for C(all) packages or only for C(new) packages. - - In case of C(state=latest) already installed packages which will be updated to a newer version are not counted as C(new). + - In case of I(state=latest) already installed packages which will be updated to a newer version are not counted as C(new). default: new choices: [ all, new ] type: str diff --git a/plugins/modules/packaging/os/pkgng.py b/plugins/modules/packaging/os/pkgng.py index 2160c80e48..5f4a2a5f27 100644 --- a/plugins/modules/packaging/os/pkgng.py +++ b/plugins/modules/packaging/os/pkgng.py @@ -24,10 +24,10 @@ options: name: description: - Name or list of names of packages to install/remove. - - "With I(name=*), I(state: latest) will operate, but I(state: present) and I(state: absent) will be noops." + - "With I(name=*), I(state=latest) will operate, but I(state=present) and I(state=absent) will be noops." - > Warning: In Ansible 2.9 and earlier this module had a misfeature - where I(name=*) with I(state: latest) or I(state: present) would + where I(name=*) with I(state=latest) or I(state=present) would install every package from every package repository, filling up the machines disk. Avoid using them unless you are certain that your role will only be used with newer versions. diff --git a/plugins/modules/packaging/os/pkgutil.py b/plugins/modules/packaging/os/pkgutil.py index e81f176b4a..d15c9d2726 100644 --- a/plugins/modules/packaging/os/pkgutil.py +++ b/plugins/modules/packaging/os/pkgutil.py @@ -27,7 +27,7 @@ options: name: description: - The name of the package. - - When using C(state=latest), this can be C('*'), which updates all installed packages managed by pkgutil. + - When using I(state=latest), this can be C('*'), which updates all installed packages managed by pkgutil. type: list required: true elements: str diff --git a/plugins/modules/packaging/os/sorcery.py b/plugins/modules/packaging/os/sorcery.py index e1d353dbce..23070ad3b3 100644 --- a/plugins/modules/packaging/os/sorcery.py +++ b/plugins/modules/packaging/os/sorcery.py @@ -39,7 +39,7 @@ options: description: - Whether to cast, dispel or rebuild a package - state C(cast) is an equivalent of C(present), not C(latest) - - state C(latest) always triggers C(update_cache=true) + - state C(latest) always triggers I(update_cache=true) - state C(rebuild) implies cast of all specified spells, not only those existed before choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"] diff --git a/plugins/modules/packaging/os/svr4pkg.py b/plugins/modules/packaging/os/svr4pkg.py index 6501d36bb4..51e43b079f 100644 --- a/plugins/modules/packaging/os/svr4pkg.py +++ b/plugins/modules/packaging/os/svr4pkg.py @@ -39,13 +39,13 @@ options: src: description: - - Specifies the location to install the package from. Required when C(state=present). + - Specifies the location to install the package from. Required when I(state=present). - "Can be any path acceptable to the C(pkgadd) command's C(-d) option. e.g.: C(somefile.pkg), C(/dir/with/pkgs), C(http:/server/mypkgs.pkg)." - If using a file or directory, they must already be accessible by the host. See the M(ansible.builtin.copy) module for a way to get them there. type: str proxy: description: - - HTTP[s] proxy to be used if C(src) is a URL. + - HTTP[s] proxy to be used if I(src) is a URL. type: str response_file: description: diff --git a/plugins/modules/packaging/os/zypper.py b/plugins/modules/packaging/os/zypper.py index d75a8c593b..c5404975e8 100644 --- a/plugins/modules/packaging/os/zypper.py +++ b/plugins/modules/packaging/os/zypper.py @@ -38,7 +38,7 @@ options: - Can include a version like C(name=1.0), C(name>3.4) or C(name<=2.7). If a version is given, C(oldpackage) is implied and zypper is allowed to update the package within the version range given. - You can also pass a url or a local path to a rpm file. - - When using state=latest, this can be '*', which updates all installed packages. + - When using I(state=latest), this can be '*', which updates all installed packages. required: true aliases: [ 'pkg' ] type: list diff --git a/plugins/modules/remote_management/cobbler/cobbler_system.py b/plugins/modules/remote_management/cobbler/cobbler_system.py index 7b70ccac34..34ef8c5701 100644 --- a/plugins/modules/remote_management/cobbler/cobbler_system.py +++ b/plugins/modules/remote_management/cobbler/cobbler_system.py @@ -137,11 +137,11 @@ EXAMPLES = r''' RETURN = r''' systems: description: List of systems - returned: C(state=query) and C(name) is not provided + returned: I(state=query) and I(name) is not provided type: list system: description: (Resulting) information about the system we are working with - returned: when C(name) is provided + returned: when I(name) is provided type: dict ''' diff --git a/plugins/modules/source_control/github/github_key.py b/plugins/modules/source_control/github/github_key.py index 10dd3f9c00..23b5d53324 100644 --- a/plugins/modules/source_control/github/github_key.py +++ b/plugins/modules/source_control/github/github_key.py @@ -27,7 +27,7 @@ options: type: str pubkey: description: - - SSH public key value. Required when C(state=present). + - SSH public key value. Required when I(state=present). type: str state: description: @@ -39,7 +39,7 @@ options: description: - The default is C(true), which will replace the existing remote key if it's different than C(pubkey). If C(false), the key will only be - set if no key with the given C(name) exists. + set if no key with the given I(name) exists. type: bool default: true diff --git a/plugins/modules/system/dconf.py b/plugins/modules/system/dconf.py index a389179e51..61bf6f0e3f 100644 --- a/plugins/modules/system/dconf.py +++ b/plugins/modules/system/dconf.py @@ -34,7 +34,7 @@ notes: - Keep in mind that the C(dconf) CLI tool, which this module wraps around, utilises an unusual syntax for the values (GVariant). For example, if you wanted to provide a string value, the correct syntax would be - C(value="'myvalue'") - with single quotes as part of the Ansible parameter + I(value="'myvalue'") - with single quotes as part of the Ansible parameter value. - When using loops in combination with a value like :code:`"[('xkb', 'us'), ('xkb', 'se')]"`, you need to be aware of possible diff --git a/plugins/modules/system/open_iscsi.py b/plugins/modules/system/open_iscsi.py index 23157df874..7704fd8b7f 100644 --- a/plugins/modules/system/open_iscsi.py +++ b/plugins/modules/system/open_iscsi.py @@ -78,7 +78,7 @@ options: - Whether the list of target nodes on the portal should be (re)discovered and added to the persistent iSCSI database. - Keep in mind that C(iscsiadm) discovery resets configuration, like C(node.startup) - to manual, hence combined with C(auto_node_startup=true) will always return + to manual, hence combined with I(auto_node_startup=true) will always return a changed state. type: bool default: false diff --git a/plugins/modules/system/osx_defaults.py b/plugins/modules/system/osx_defaults.py index 8f7c2a8cf3..5ad390ca33 100644 --- a/plugins/modules/system/osx_defaults.py +++ b/plugins/modules/system/osx_defaults.py @@ -51,7 +51,7 @@ options: value: description: - The value to write. - - Only required when C(state=present). + - Only required when I(state=present). type: raw state: description: diff --git a/plugins/modules/web_infrastructure/htpasswd.py b/plugins/modules/web_infrastructure/htpasswd.py index 4590607cc7..4f05d21b0d 100644 --- a/plugins/modules/web_infrastructure/htpasswd.py +++ b/plugins/modules/web_infrastructure/htpasswd.py @@ -56,7 +56,7 @@ options: type: bool default: true description: - - Used with C(state=present). If specified, the file will be created + - Used with I(state=present). If specified, the file will be created if it does not already exist. If set to C(false), will fail if the file does not exist notes: