Skip to content

Commit d5b657d

Browse files
[PR #11037/c984b896 backport][stable-12] docs style adjustments (#11038)
docs style adjustments (#11037) docs adjustments (cherry picked from commit c984b89) Co-authored-by: Alexei Znamensky <[email protected]>
1 parent 855a850 commit d5b657d

File tree

6 files changed

+10
-10
lines changed

6 files changed

+10
-10
lines changed

plugins/modules/dconf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
specified in Ansible code. C(gi.repository) is likely to be present on most systems which have C(dconf) but may not be
2828
present everywhere. When it is missing, a simple string comparison between values is used, and there may be false positives,
2929
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
30-
of this module, at which point the module will stop working on hosts without C(gi.repository).
30+
of this module, at which point the module C(gi.repository) is going to be required.
3131
- Detection of existing, running D-Bus session, required to change settings using C(dconf), is not 100% reliable due to
3232
implementation details of D-Bus daemon itself. This might lead to running applications not picking-up changes on-the-fly
3333
if options are changed using Ansible and C(dbus-run-session).

plugins/modules/django_dumpdata.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
description:
5050
- Path to the output file.
5151
- The fixture filename may end with V(.bz2), V(.gz), V(.lzma) or V(.xz), in which case the corresponding
52-
compression format will be used.
52+
compression format is used.
5353
- This corresponds to the C(--output) parameter for the C(django-admin dumpdata) command.
5454
type: path
5555
aliases: [output]

plugins/modules/kea_command.py

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

plugins/modules/keycloak_realm.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -532,28 +532,28 @@
532532
type: int
533533
client_session_idle_timeout:
534534
description:
535-
- All Clients will inherit from this setting, time a session is allowed to be idle before it expires.
535+
- All Clients inherit from this setting, time a session is allowed to be idle before it expires.
536536
aliases:
537537
- clientSessionIdleTimeout
538538
type: int
539539
version_added: 11.2.0
540540
client_session_max_lifespan:
541541
description:
542-
- All Clients will inherit from this setting, max time before a session is expired.
542+
- All Clients inherit from this setting, max time before a session is expired.
543543
aliases:
544544
- clientSessionMaxLifespan
545545
type: int
546546
version_added: 11.2.0
547547
client_offline_session_idle_timeout:
548548
description:
549-
- All Clients will inherit from this setting, time an offline session is allowed to be idle before it expires.
549+
- All Clients inherit from this setting, time an offline session is allowed to be idle before it expires.
550550
aliases:
551551
- clientOfflineSessionIdleTimeout
552552
type: int
553553
version_added: 11.2.0
554554
client_offline_session_max_lifespan:
555555
description:
556-
- All Clients will inherit from this setting, max time before an offline session is expired regardless of activity.
556+
- All Clients inherit from this setting, max time before an offline session is expired regardless of activity.
557557
aliases:
558558
- clientOfflineSessionMaxLifespan
559559
type: int

plugins/modules/pacman.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128
- 'In the tests, while using C(yay) as the O(executable) option, the module failed to install AUR packages with the error:
129129
C(error: target not found: <pkg>). This is caused by an incompatibility of yay with the arguments passed by this module.
130130
See L(yay bug #1744 report for details, https://github.com/Jguer/yay/issues/1744).'
131-
- The common return values `stdout` and `stderr` are returned upon success, when needed, since community.general 4.1.0.
131+
- The common return values C(stdout) and C(stderr) are returned upon success, when needed, since community.general 4.1.0.
132132
"""
133133

134134
RETURN = r"""

plugins/modules/zpool.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
check_mode:
1919
support: partial
2020
details:
21-
- In check mode, any C(zpool) subcommand that supports the dry-run flag (C(-n)) will be run with C(-n) and its simulated
21+
- In check mode, any C(zpool) subcommand that supports the dry-run flag (C(-n)) is run with C(-n) and its simulated
2222
output is included in the module's diff results.
2323
diff_mode:
2424
support: full

0 commit comments

Comments
 (0)