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

[PR #7558/fce91ebb backport][stable-7] ini_file: documentation for 'section' to stop mentioning that null can be passed (#7583)

ini_file: documentation for 'section' to stop mentioning that null can be passed (#7558)

Update ini_file's documentation for 'section' to stop mentioning that null can be passed.

(cherry picked from commit fce91ebbd4)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2023-11-23 06:53:29 +01:00 committed by GitHub
parent 833c21a2bc
commit c0cd4827da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -43,8 +43,8 @@ options:
description: description:
- Section name in INI file. This is added if O(state=present) automatically when - Section name in INI file. This is added if O(state=present) automatically when
a single value is being set. a single value is being set.
- If left empty, being omitted, or being set to V(null), the O(option) will be placed before the first O(section). - If being omitted, the O(option) will be placed before the first O(section).
- Using V(null) is also required if the config format does not support sections. - Omitting O(section) is also required if the config format does not support sections.
type: str type: str
option: option:
description: description:
@ -171,6 +171,13 @@ EXAMPLES = r'''
- pepsi - pepsi
mode: '0600' mode: '0600'
state: present state: present
- name: Add "beverage=lemon juice" outside a section in specified file
community.general.ini_file:
path: /etc/conf
option: beverage
value: lemon juice
state: present
''' '''
import io import io