Clean up module documentation (#36909)

* Clean up module documentation

This PR includes:
- Removal of `default: None` (and variations)
- Removal of `required: false`
- Fixing booleans and `type: bool` where required

* Fix remaining (new) validation issues

lib/ansible/modules/packaging/language/bower.py

@@ -25,19 +25,16 @@ options:
   name:
     description:
       - The name of a bower package to install
-    required: false
   offline:
     description:
       - Install packages from local cache, if the packages were installed before
-    required: false
-    default: no
-    choices: [ "yes", "no" ]
+    type: bool
+    default: 'no'
   production:
     description:
       - Install with --production flag
-    required: false
-    default: no
-    choices: [ "yes", "no" ]
+    type: bool
+    default: 'no'
     version_added: "2.0"
   path:
     description:
@@ -46,19 +43,15 @@ options:
   relative_execpath:
     description:
       - Relative path to bower executable from install path
-    default: null
-    required: false
     version_added: "2.1"
   state:
     description:
       - The state of the bower package
-    required: false
     default: present
     choices: [ "present", "absent", "latest" ]
   version:
     description:
       - The version to be installed
-    required: false
 '''
 
 EXAMPLES = '''

lib/ansible/modules/packaging/language/bundler.py

@@ -24,19 +24,15 @@ options:
   executable:
     description:
       - The path to the bundler executable
-    required: false
-    default: null
   state:
     description:
       - The desired state of the Gem bundle. C(latest) updates gems to the most recent, acceptable version
-    required: false
     choices: [present, latest]
     default: present
   chdir:
     description:
       - The directory to execute the bundler commands from. This directoy
         needs to contain a valid Gemfile or .bundle/ directory
-    required: false
     default: temporary working directory
   exclude_groups:
     description:
@@ -44,46 +40,38 @@ options:
         applies when state is C(present). Bundler considers this
         a 'remembered' property for the Gemfile and will automatically exclude
         groups in future operations even if C(exclude_groups) is not set
-    required: false
-    default: null
   clean:
     description:
       - Only applies if state is C(present). If set removes any gems on the
         target host that are not in the gemfile
-    required: false
-    choices: [yes, no]
-    default: "no"
+    type: bool
+    default: 'no'
   gemfile:
     description:
       - Only applies if state is C(present). The path to the gemfile to use to install gems.
-    required: false
     default: Gemfile in current directory
   local:
     description:
       - If set only installs gems from the cache on the target host
-    required: false
-    choices: [yes, no]
-    default: "no"
+    type: bool
+    default: 'no'
   deployment_mode:
     description:
       - Only applies if state is C(present). If set it will only install gems
         that are in the default or production groups. Requires a Gemfile.lock
         file to have been created prior
-    required: false
-    choices: [yes, no]
-    default: "no"
+    type: bool
+    default: 'no'
   user_install:
     description:
       - Only applies if state is C(present). Installs gems in the local user's cache or for all users
-    required: false
-    choices: [yes, no]
-    default: "yes"
+    type: bool
+    default: 'yes'
   gem_path:
     description:
       - Only applies if state is C(present). Specifies the directory to
         install the gems into. If C(chdir) is set then this path is relative to
         C(chdir)
-    required: false
     default: RubyGems gem paths
   binstub_directory:
     description:
@@ -92,15 +80,11 @@ options:
         within the context of the Gemfile and fail if any required gem
         dependencies are not installed. If C(chdir) is set then this path is
         relative to C(chdir)
-    required: false
-    default: null
   extra_args:
     description:
       - A space separated string of additional commands that can be applied to
         the Bundler command. Refer to the Bundler documentation for more
         information
-    required: false
-    default: null
 author: "Tim Hoiberg (@thoiberg)"
 '''
 

lib/ansible/modules/packaging/language/cpanm.py

@@ -24,59 +24,53 @@ options:
   name:
     description:
       - The name of the Perl library to install. You may use the "full distribution path", e.g.  MIYAGAWA/Plack-0.99_05.tar.gz
-    required: false
-    default: null
     aliases: ["pkg"]
   from_path:
     description:
       - The local directory from where to install
-    required: false
-    default: null
   notest:
     description:
       - Do not run unit tests
-    required: false
-    default: false
+    type: bool
+    default: 'no'
   locallib:
     description:
       - Specify the install base to install modules
-    required: false
-    default: false
+    type: bool
+    default: 'no'
   mirror:
     description:
       - Specifies the base URL for the CPAN mirror to use
-    required: false
-    default: false
+    type: bool
+    default: 'no'
   mirror_only:
     description:
       - Use the mirror's index file instead of the CPAN Meta DB
-    required: false
-    default: false
+    type: bool
+    default: 'no'
   installdeps:
     description:
       - Only install dependencies
-    required: false
-    default: false
+    type: bool
+    default: 'no'
     version_added: "2.0"
   version:
     description:
       - minimum version of perl module to consider acceptable
-    required: false
-    default: false
+    type: bool
+    default: 'no'
     version_added: "2.1"
   system_lib:
     description:
      -  Use this if you want to install modules to the system perl include path. You must be root or have "passwordless" sudo for this to work.
      -  This uses the cpanm commandline option '--sudo', which has nothing to do with ansible privilege escalation.
-    required: false
-    default: false
+    type: bool
+    default: 'no'
     version_added: "2.0"
     aliases: ['use_sudo']
   executable:
     description:
       - Override the path to the cpanm executable
-    required: false
-    default: null
     version_added: "2.1"
 notes:
    - Please note that U(http://search.cpan.org/dist/App-cpanminus/bin/cpanm, cpanm) must be installed on the remote host.

lib/ansible/modules/packaging/language/easy_install.py

@@ -25,14 +25,10 @@ options:
     description:
       - A Python library name
     required: true
-    default: null
-    aliases: []
   virtualenv:
     description:
       - an optional I(virtualenv) directory path to install into. If the
         I(virtualenv) does not exist, it is created automatically
-    required: false
-    default: null
   virtualenv_site_packages:
     version_added: "1.1"
     description:
@@ -41,15 +37,13 @@ options:
         changed on an already existing virtual environment it will not
         have any effect, the environment must be deleted and newly
         created.
-    required: false
-    default: "no"
-    choices: [ "yes", "no" ]
+    type: bool
+    default: 'no'
   virtualenv_command:
     version_added: "1.1"
     description:
       - The command to create the virtual environment with. For example
         C(pyvenv), C(virtualenv), C(virtualenv2).
-    required: false
     default: virtualenv
   executable:
     description:
@@ -59,13 +53,10 @@ options:
         and 3.3 installations in the system and you want to run easy_install
         for the Python 3.3 installation.
     version_added: "1.3"
-    required: false
-    default: null
   state:
     version_added: "2.0"
     description:
       - The desired state of the library. C(latest) ensures that the latest version is installed.
-    required: false
     choices: [present, latest]
     default: present
 notes:

lib/ansible/modules/packaging/language/maven_artifact.py

@@ -39,68 +39,54 @@ options:
     version:
         description:
             - The maven version coordinate
-        required: false
         default: latest
     classifier:
         description:
             - The maven classifier coordinate
-        required: false
-        default: null
     extension:
         description:
             - The maven type/extension coordinate
-        required: false
         default: jar
     repository_url:
         description:
             - The URL of the Maven Repository to download from.
             - Use s3://... if the repository is hosted on Amazon S3, added in version 2.2.
-        required: false
         default: http://repo1.maven.org/maven2
     username:
         description:
             - The username to authenticate as to the Maven Repository. Use AWS secret key of the repository is hosted on S3
-        required: false
-        default: null
         aliases: [ "aws_secret_key" ]
     password:
         description:
             - The password to authenticate with to the Maven Repository. Use AWS secret access key of the repository is hosted on S3
-        required: false
-        default: null
         aliases: [ "aws_secret_access_key" ]
     dest:
         description:
             - The path where the artifact should be written to
             - If file mode or ownerships are specified and destination path already exists, they affect the downloaded file
         required: true
-        default: false
     state:
         description:
             - The desired state of the artifact
-        required: true
         default: present
         choices: [present,absent]
     timeout:
         description:
             - Specifies a timeout in seconds for the connection attempt
-        required: false
         default: 10
         version_added: "2.3"
     validate_certs:
         description:
             - If C(no), SSL certificates will not be validated. This should only be set to C(no) when no other option exists.
-        required: false
+        type: bool
         default: 'yes'
-        choices: ['yes', 'no']
         version_added: "1.9.3"
     keep_name:
         description:
             - If C(yes), the downloaded artifact's name is preserved, i.e the version number remains part of it.
             - This option only has effect when C(dest) is a directory and C(version) is set to C(latest).
-        required: false
+        type: bool
         default: 'no'
-        choices: ['yes', 'no']
         version_added: "2.4"
     verify_checksum:
         description:

lib/ansible/modules/packaging/language/pear.py

@@ -34,14 +34,11 @@ options:
     state:
         description:
             - Desired state of the package.
-        required: false
         default: "present"
         choices: ["present", "absent", "latest"]
     executable:
       description:
         - Path to the pear executable
-      required: false
-      default: null
       version_added: "2.4"
 '''