[PR #9364/6b7ea344 backport][stable-10] [prox ... pyth]*: normalize docs (#9400)

[prox ... pyth]*: normalize docs (#9364)

* [prox ... pyth]*: normalize docs

* Apply suggestions from code review

Co-authored-by: IamLunchbox <56757745+IamLunchbox@users.noreply.github.com>

* Update plugins/modules/pushbullet.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/pushbullet.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: IamLunchbox <56757745+IamLunchbox@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit 6b7ea3443d)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2024-12-26 08:39:32 +01:00 committed by GitHub
parent 4f9e7bd793
commit 7a44dbfe45
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
23 changed files with 633 additions and 729 deletions

View file

@ -8,8 +8,7 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r'''
---
DOCUMENTATION = r"""
module: puppet
short_description: Runs puppet
description:
@ -66,11 +65,11 @@ options:
version_added: 5.1.0
logdest:
description:
- Where the puppet logs should go, if puppet apply is being used.
- V(all) will go to both C(console) and C(syslog).
- V(stdout) will be deprecated and replaced by C(console).
- Where the puppet logs should go, if puppet apply is being used.
- V(all) will go to both C(console) and C(syslog).
- V(stdout) will be deprecated and replaced by C(console).
type: str
choices: [ all, stdout, syslog ]
choices: [all, stdout, syslog]
default: stdout
certname:
description:
@ -94,7 +93,7 @@ options:
type: str
use_srv_records:
description:
- Toggles use_srv_records flag
- Toggles use_srv_records flag.
type: bool
summarize:
description:
@ -103,8 +102,8 @@ options:
default: false
waitforlock:
description:
- The maximum amount of time C(puppet) should wait for an already running C(puppet) agent to finish before starting.
- If a number without unit is provided, it is assumed to be a number of seconds. Allowed units are V(m) for minutes and V(h) for hours.
- The maximum amount of time C(puppet) should wait for an already running C(puppet) agent to finish before starting.
- If a number without unit is provided, it is assumed to be a number of seconds. Allowed units are V(m) for minutes and V(h) for hours.
type: str
version_added: 9.0.0
verbose:
@ -119,27 +118,27 @@ options:
default: false
show_diff:
description:
- Whether to print file changes details
- Whether to print file changes details.
type: bool
default: false
environment_lang:
description:
- The lang environment to use when running the puppet agent.
- The default value, V(C), is supported on every system, but can lead to encoding errors if UTF-8 is used in the output
- Use V(C.UTF-8) or V(en_US.UTF-8) or similar UTF-8 supporting locales in case of problems. You need to make sure
the selected locale is supported on the system the puppet agent runs on.
- Starting with community.general 9.1.0, you can use the value V(auto) and the module will
try and determine the best parseable locale to use.
- The default value, V(C), is supported on every system, but can lead to encoding errors if UTF-8 is used in the output.
- Use V(C.UTF-8) or V(en_US.UTF-8) or similar UTF-8 supporting locales in case of problems. You need to make sure the selected locale is
supported on the system the puppet agent runs on.
- Starting with community.general 9.1.0, you can use the value V(auto) and the module will try and determine the best parseable locale to
use.
type: str
default: C
version_added: 8.6.0
requirements:
- puppet
- puppet
author:
- Monty Taylor (@emonty)
'''
- Monty Taylor (@emonty)
"""
EXAMPLES = r'''
EXAMPLES = r"""
- name: Run puppet agent and fail if anything goes wrong
community.general.puppet:
@ -162,10 +161,10 @@ EXAMPLES = r'''
- name: Run puppet using a specific tags
community.general.puppet:
tags:
- update
- nginx
- update
- nginx
skip_tags:
- service
- service
- name: Wait 30 seconds for any current puppet runs to finish
community.general.puppet:
@ -184,7 +183,7 @@ EXAMPLES = r'''
modulepath: /etc/puppet/modules:/opt/stack/puppet-modules:/usr/share/openstack-puppet/modules
logdest: all
manifest: /var/lib/example/puppet_step_config.pp
'''
"""
import json
import os