ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Improve/fix dconf documentation using semantic markup (#6544)

Browse source 
Improve/fix dconf documentation using semantic markup.
This commit is contained in:
Felix Fontein 2023-05-29 18:55:12 +02:00 committed by GitHub
parent 4c0eff02e5
commit 57f8d84776
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
plugins/modules/dconf.py
View file

@ -46,11 +46,11 @@ notes:
- Keep in mind that the C(dconf) CLI tool, which this module wraps around, - Keep in mind that the C(dconf) CLI tool, which this module wraps around,
utilises an unusual syntax for the values (GVariant). For example, if you utilises an unusual syntax for the values (GVariant). For example, if you
wanted to provide a string value, the correct syntax would be wanted to provide a string value, the correct syntax would be
I(value="'myvalue'") - with single quotes as part of the Ansible parameter O(value="'myvalue'") - with single quotes as part of the Ansible parameter
value. value.
- When using loops in combination with a value like - When using loops in combination with a value like
"[('xkb', 'us'), ('xkb', 'se')]", you need to be aware of possible V("[('xkb', 'us'\), ('xkb', 'se'\)]"), you need to be aware of possible
type conversions. Applying a filter C({{ item.value | string }}) type conversions. Applying a filter V({{ item.value | string }})
to the parameter variable can avoid potential conversion problems. to the parameter variable can avoid potential conversion problems.
- The easiest way to figure out exact syntax/value you need to provide for a - The easiest way to figure out exact syntax/value you need to provide for a
key is by making the configuration change in application affected by the key is by making the configuration change in application affected by the
@ -76,7 +76,7 @@ options:
- Value to set for the specified dconf key. Value should be specified in - Value to set for the specified dconf key. Value should be specified in
GVariant format. Due to complexity of this format, it is best to have a GVariant format. Due to complexity of this format, it is best to have a
look at existing values in the dconf database. look at existing values in the dconf database.
- Required for I(state=present). - Required for O(state=present).
- Although the type is specified as "raw", it should typically be - Although the type is specified as "raw", it should typically be
specified as a string. However, boolean values in particular are specified as a string. However, boolean values in particular are
handled properly even when specified as booleans rather than strings handled properly even when specified as booleans rather than strings