Fix the docs for the inventory plugins.

Documenting the structure of the dictionary to pass in needs to be done
via suboptions rather than putting the structure directoly inside of the
toplevel option.
This commit is contained in:
Toshio Kuratomi
2020-05-20 07:48:35 -07:00
parent 2f7b55270d
commit d9ece473dd
2 changed files with 110 additions and 108 deletions

View File

@@ -28,6 +28,7 @@ DOCUMENTATION = '''
- Optional list of cluster connection settings. If no connections are provided, the default - Optional list of cluster connection settings. If no connections are provided, the default
I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces
the active user is authorized to access. the active user is authorized to access.
suboptions:
name: name:
description: description:
- Optional name to assign to the cluster. If not provided, a name is constructed from the server - Optional name to assign to the cluster. If not provided, a name is constructed from the server

View File

@@ -28,6 +28,7 @@ DOCUMENTATION = '''
- Optional list of cluster connection settings. If no connections are provided, the default - Optional list of cluster connection settings. If no connections are provided, the default
I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces I(~/.kube/config) and active context will be used, and objects will be returned for all namespaces
the active user is authorized to access. the active user is authorized to access.
suboptions:
name: name:
description: description:
- Optional name to assign to the cluster. If not provided, a name is constructed from the server - Optional name to assign to the cluster. If not provided, a name is constructed from the server