mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-04-25 05:02:46 +00:00
4fa82b9617
* Make all doc fragments private. * Make all plugin utils private. * Make all module utils private. * Reformat. * Changelog fragment. * Update configs and ignores. * Adjust unit test names.
32 lines
985 B
Python
32 lines
985 B
Python
# Copyright (c) 2022, Guillaume MARTINEZ <lunik@tiwabbit.fr>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
# Note that this doc fragment is **PRIVATE** to the collection. It can have breaking changes at any time.
|
|
# Do not use this from other collections or standalone plugins/modules!
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
class ModuleDocFragment:
|
|
# Standard documentation fragment
|
|
DOCUMENTATION = r"""
|
|
options:
|
|
wait:
|
|
description:
|
|
- Wait for the resource to reach its desired state before returning.
|
|
type: bool
|
|
default: true
|
|
wait_timeout:
|
|
type: int
|
|
description:
|
|
- Time to wait for the resource to reach the expected state.
|
|
required: false
|
|
default: 300
|
|
wait_sleep_time:
|
|
type: int
|
|
description:
|
|
- Time to wait before every attempt to check the state of the resource.
|
|
required: false
|
|
default: 3
|
|
"""
|