1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-02-04 07:51:50 +00:00

docs style adjustments (#11037)

docs adjustments
This commit is contained in:
Alexei Znamensky 2025-11-07 10:29:44 +13:00 committed by GitHub
parent 3c42ec730d
commit c984b89667
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 10 additions and 10 deletions

View file

@ -27,7 +27,7 @@ notes:
specified in Ansible code. C(gi.repository) is likely to be present on most systems which have C(dconf) but may not be
present everywhere. When it is missing, a simple string comparison between values is used, and there may be false positives,
that is, Ansible may think that a value is being changed when it is not. This fallback is to be removed in a future version
of this module, at which point the module will stop working on hosts without C(gi.repository).
of this module, at which point the module C(gi.repository) is going to be required.
- Detection of existing, running D-Bus session, required to change settings using C(dconf), is not 100% reliable due to
implementation details of D-Bus daemon itself. This might lead to running applications not picking-up changes on-the-fly
if options are changed using Ansible and C(dbus-run-session).

View file

@ -49,7 +49,7 @@ options:
description:
- Path to the output file.
- The fixture filename may end with V(.bz2), V(.gz), V(.lzma) or V(.xz), in which case the corresponding
compression format will be used.
compression format is used.
- This corresponds to the C(--output) parameter for the C(django-admin dumpdata) command.
type: path
aliases: [output]

View file

@ -15,7 +15,7 @@ description:
- This module supports sending arbitrary commands and returns the server response unchecked;
while it would be possible to write individual modules for specific KEA service commands,
that approach would not scale, as the FOSS hooks alone provide dozens of commands.
- Between sending the command and parsing the result status, RV(ignore:changed) will register as V(true) if an error occurs,
- Between sending the command and parsing the result status, RV(ignore:changed) registers as V(true) if an error occurs,
to err on the safe side.
version_added: '12.0.0'
author: Thorsten Glaser (@mirabilos)
@ -54,7 +54,7 @@ options:
description:
- The full pathname of the Unix Domain Socket to connect to.
- The default value is suitable for C(kea-dhcp4-server) on Debian trixie.
- This module directly interfacees via UDS; the HTTP wrappers are not supported.
- This module directly interfaces using UDS; the HTTP wrappers are not supported.
type: path
default: /run/kea/kea4-ctrl-socket
extends_documentation_fragment:

View file

@ -532,28 +532,28 @@ options:
type: int
client_session_idle_timeout:
description:
- All Clients will inherit from this setting, time a session is allowed to be idle before it expires.
- All Clients inherit from this setting, time a session is allowed to be idle before it expires.
aliases:
- clientSessionIdleTimeout
type: int
version_added: 11.2.0
client_session_max_lifespan:
description:
- All Clients will inherit from this setting, max time before a session is expired.
- All Clients inherit from this setting, max time before a session is expired.
aliases:
- clientSessionMaxLifespan
type: int
version_added: 11.2.0
client_offline_session_idle_timeout:
description:
- All Clients will inherit from this setting, time an offline session is allowed to be idle before it expires.
- All Clients inherit from this setting, time an offline session is allowed to be idle before it expires.
aliases:
- clientOfflineSessionIdleTimeout
type: int
version_added: 11.2.0
client_offline_session_max_lifespan:
description:
- All Clients will inherit from this setting, max time before an offline session is expired regardless of activity.
- All Clients inherit from this setting, max time before an offline session is expired regardless of activity.
aliases:
- clientOfflineSessionMaxLifespan
type: int

View file

@ -128,7 +128,7 @@ notes:
- 'In the tests, while using C(yay) as the O(executable) option, the module failed to install AUR packages with the error:
C(error: target not found: <pkg>). This is caused by an incompatibility of yay with the arguments passed by this module.
See L(yay bug #1744 report for details, https://github.com/Jguer/yay/issues/1744).'
- The common return values `stdout` and `stderr` are returned upon success, when needed, since community.general 4.1.0.
- The common return values C(stdout) and C(stderr) are returned upon success, when needed, since community.general 4.1.0.
"""
RETURN = r"""

View file

@ -18,7 +18,7 @@ attributes:
check_mode:
support: partial
details:
- In check mode, any C(zpool) subcommand that supports the dry-run flag (C(-n)) will be run with C(-n) and its simulated
- In check mode, any C(zpool) subcommand that supports the dry-run flag (C(-n)) is run with C(-n) and its simulated
output is included in the module's diff results.
diff_mode:
support: full