From 37d25436e89c2cc4e3ad8609682fc46966b0e5de Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Wed, 22 Jun 2022 14:44:30 +0200 Subject: [PATCH] Fix docs. (#4881) (#4883) (cherry picked from commit aa4c994dfd06c8f619c29ee19029aad3e45f66c8) Co-authored-by: Felix Fontein --- plugins/callback/log_plays.py | 2 +- plugins/callback/selective.py | 4 ++-- plugins/lookup/chef_databag.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/callback/log_plays.py b/plugins/callback/log_plays.py index 2539bd9ade..3a9531096d 100644 --- a/plugins/callback/log_plays.py +++ b/plugins/callback/log_plays.py @@ -12,7 +12,7 @@ DOCUMENTATION = ''' type: notification short_description: write playbook output to log file description: - - This callback writes playbook output to a file per host in the `/var/log/ansible/hosts` directory + - This callback writes playbook output to a file per host in the C(/var/log/ansible/hosts) directory requirements: - Whitelist in configuration - A writeable /var/log/ansible/hosts directory by the user executing Ansible on the controller diff --git a/plugins/callback/selective.py b/plugins/callback/selective.py index 403eb84b33..944d8edc7c 100644 --- a/plugins/callback/selective.py +++ b/plugins/callback/selective.py @@ -14,9 +14,9 @@ DOCUMENTATION = ''' - set as main display callback short_description: only print certain tasks description: - - This callback only prints tasks that have been tagged with `print_action` or that have failed. + - This callback only prints tasks that have been tagged with C(print_action) or that have failed. This allows operators to focus on the tasks that provide value only. - - Tasks that are not printed are placed with a '.'. + - Tasks that are not printed are placed with a C(.). - If you increase verbosity all tasks are printed. options: nocolor: diff --git a/plugins/lookup/chef_databag.py b/plugins/lookup/chef_databag.py index f5ccc766c2..f3438f6206 100644 --- a/plugins/lookup/chef_databag.py +++ b/plugins/lookup/chef_databag.py @@ -16,7 +16,7 @@ DOCUMENTATION = ''' The lookup order mirrors the one from Chef, all folders in the base path are walked back looking for the following configuration file in order : .chef/knife.rb, ~/.chef/knife.rb, /etc/chef/client.rb" requirements: - - "pychef (python library https://pychef.readthedocs.io `pip install pychef`)" + - "pychef (L(Python library, https://pychef.readthedocs.io), C(pip install pychef))" options: name: description: