Windows: Add "special" parameter types to docs (#42853)

* Windows: Add special parameter types

Adding explicit parameter types now exposes this information in the
module documentation, and proves really helpful.

We only do this for non-string types as strings, mostly because strings
are implicit.

PS We also make copyright statements consistent and use #Requires for
explicit library imports

* Type "string" must be type "str"

* A few more Copyright corrections

* More fixes

* Don't add file encoding to Powershell files

* Don't add missing interfacetypes parameter

Otherwise CI demands an incorrect version_added

* Small fix
This commit is contained in:
Dag Wieers 2018-07-17 23:29:05 +02:00 committed by Matt Davis
parent 290df027e3
commit 95a1170908
127 changed files with 327 additions and 664 deletions

View file

@ -28,10 +28,12 @@ options:
description:
- File to be unzipped (provide absolute path).
required: yes
type: path
dest:
description:
- Destination of zip file (provide absolute path of directory). If it does not exist, the directory will be created.
required: yes
type: path
delete_archive:
description:
- Remove the zip file, after unzipping.
@ -47,6 +49,7 @@ options:
creates:
description:
- If this file or directory exists the specified src will not be extracted.
type: path
notes:
- This module is not really idempotent, it will extract the archive every time, and report a change.
- For extracting any compression types other than .zip, the PowerShellCommunityExtensions (PSCX) Module is required. This module (in conjunction with PSCX)