Windows: Add missing parameter types and doc fixes (#50232)

* Windows: Add missing parameter types and doc fixes

This PR includes:
- Adding missing parameter types
- Various documentation fixes

* Update lib/ansible/modules/windows/win_copy.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Update lib/ansible/modules/windows/win_credential.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Update lib/ansible/modules/windows/win_domain_computer.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Update lib/ansible/modules/windows/win_domain_user.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Update lib/ansible/modules/windows/win_environment.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Update lib/ansible/modules/windows/win_psexec.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Update lib/ansible/modules/windows/win_uri.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Update lib/ansible/modules/windows/win_wait_for.py

Co-Authored-By: dagwieers <dag@wieers.com>

* Ensure docstrings are raw strings
This commit is contained in:
Dag Wieers
2019-01-03 17:50:44 +01:00
committed by Alicia Cozine
parent f80ce60cf9
commit d863027159
92 changed files with 982 additions and 716 deletions

View File

@@ -22,22 +22,26 @@ options:
name:
description:
- Name of the powershell module that has to be installed.
type: str
required: yes
allow_clobber:
description:
- If C(yes) imports all commands, even if they have the same names as commands that already exists. Available only in Powershell 5.1 or higher.
type: bool
default: 'no'
default: no
repository:
description:
- Name of the custom repository to register or use.
type: str
url:
description:
- URL of the custom repository to register.
type: str
state:
description:
- If C(present) a new module is installed.
- If C(absent) a module is removed.
type: str
choices: [ absent, present ]
default: present
notes:
@@ -48,7 +52,7 @@ author:
- Daniele Lazzari (@dlazz)
'''
EXAMPLES = '''
EXAMPLES = r'''
---
- name: Add a powershell module
win_psmodule:
@@ -80,21 +84,21 @@ EXAMPLES = '''
state: absent
'''
RETURN = '''
RETURN = r'''
---
output:
description: a message describing the task result.
description: A message describing the task result.
returned: always
sample: "Module PowerShellCookbook installed"
type: str
nuget_changed:
description: true when Nuget package provider is installed
description: True when Nuget package provider is installed.
returned: always
type: bool
sample: True
sample: true
repository_changed:
description: true when a custom repository is installed or removed
description: True when a custom repository is installed or removed.
returned: always
type: bool
sample: True
sample: true
'''