Windows: Clean up documentation (#36684)

This PR includes:
- Further cleanup of BOTMETA.yml
- Cleanup of author github handles
- Use of proper booleans
- One-line license statement
- Copyright format statement
- Smaller cleanups
This commit is contained in:
Dag Wieers 2018-02-25 03:09:54 +01:00 committed by GitHub
commit 07e8fb5dbb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
81 changed files with 751 additions and 1591 deletions

View file

@ -1,12 +1,13 @@
#!/usr/bin/python
# Copyright 2015, Hans-Joachim Kliemeck <git@kliemeck.de>
# -*- coding: utf-8 -*-
# Copyright: (c) 2015, Hans-Joachim Kliemeck <git@kliemeck.de>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'core'}
DOCUMENTATION = r'''
---
module: win_share
@ -24,21 +25,19 @@ options:
name:
description:
- Share name.
required: True
required: yes
path:
description:
- Share directory.
required: True
required: yes
state:
description:
- Specify whether to add C(present) or remove C(absent) the specified share.
choices:
- present
- absent
choices: [ absent, present ]
default: present
description:
description:
- Share description
- Share description.
list:
description:
- Specify whether to allow or deny file listing, in case user got no permission on share.
@ -66,7 +65,7 @@ options:
- None
- Programs
- Unknown
default: "Manual"
default: Manual
version_added: "2.3"
encrypt:
description: Sets whether to encrypt the traffic to the share or not.