win_defrag: Fixes to documentation (#32634)

lib/ansible/modules/windows/win_defrag.ps1

@@ -1,23 +1,10 @@
 #!powershell
-# This file is part of Ansible
+# -*- coding: utf-8 -*-
 #
-# (c) 2017, Dag Wieers <dag@wieers.com>
+# Copyright: (c) 2017, Dag Wieers (@dagwieers) <dag@wieers.com>
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 
-# WANT_JSON
+#Requires -Module Ansible.ModuleUtils.Legacy
-# POWERSHELL_COMMON
 
 $ErrorActionPreference = "Stop"
 

lib/ansible/modules/windows/win_defrag.py

@@ -1,42 +1,27 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# Copyright 2017, Dag Wieers <dag@wieers.com>
+# Copyright: 2017, Dag Wieers (@dagwieers) <dag@wieers.com>
-#
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
-# This file is part of Ansible
-#
-# Ansible is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Ansible is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 
 ANSIBLE_METADATA = {'metadata_version': '1.1',
                     'status': ['preview'],
                     'supported_by': 'community'}
 
-
 DOCUMENTATION = r'''
 ---
 module: win_defrag
 version_added: '2.4'
-short_description: Consolidate fragmented files on local volumes.
+short_description: Consolidate fragmented files on local volumes
 description:
 - Locates and consolidates fragmented files on local volumes to improve system performance.
 - 'More information regarding C(win_defrag) is available from: U(https://technet.microsoft.com/en-us/library/cc731650(v=ws.11).aspx)'
 options:
-  included_volumes:
+  include_volumes:
     description:
     - A list of drive letters or mount point paths of the volumes to be defragmented.
     - If this parameter is omitted, all volumes (not excluded) will be fragmented.
-  excluded_volumes:
+  exclude_volumes:
     description:
     - A list of drive letters or mount point paths to exclude from defragmentation.
   freespace_consolidation:
@@ -45,15 +30,17 @@ options:
   priority:
     description:
     - Run the operation at low or normal priority.
-    default: low
     choices: [ low, normal ]
+    default: low
   parallel:
     description:
     - Run the operation on each volume in parallel in the background.
+    type: bool
     default: 'no'
-    choices: [ 'yes', 'no' ]
+requirements:
-requirements: [ defrag.exe ]
+- defrag.exe
-author: Dag Wieers (@dagwieers)
+author:
+- Dag Wieers (@dagwieers)
 '''
 
 EXAMPLES = r'''