Removed default comments, install/param -> private, typed mode/dev vars

Author: danquack

REFERENCE.md

@@ -5,10 +5,15 @@
 
 **Classes**
 
+_Public Classes_
+
 * [`python`](#python): Installs and manages python, python-dev, python-virtualenv and gunicorn.
 * [`python::config`](#pythonconfig): Optionally installs the gunicorn service
-* [`python::install`](#pythoninstall): Installs core python packages
-* [`python::params`](#pythonparams): The python Module default configuration settings.
+
+_Private Classes_
+
+* `python::install`: Installs core python packages
+* `python::params`: The python Module default configuration settings.
 
 **Defined types**
 
@@ -71,43 +76,39 @@ Default value: $python::params::version
 
 Data type: `Enum['absent', 'present', 'latest']`
 
-Desired installation state for python-pip. Boolean values are deprecated.
-Allowed values: 'absent', 'present', 'latest'
+Desired installation state for python-pip.
 
 Default value: $python::params::pip
 
 ##### `dev`
 
-Data type: `Any`
+Data type: `Enum['absent', 'present', 'latest']`
 
-Desired installation state for python-dev. Boolean values are deprecated.
-Allowed values: 'absent', 'present', 'latest'
+Desired installation state for python-dev.
 
 Default value: $python::params::dev
 
 ##### `virtualenv`
 
 Data type: `Enum['absent', 'present', 'latest']`
 
-Desired installation state for python-virtualenv. Boolean values are deprecated
-Allowed values: 'absent', 'present', 'latest
+Desired installation state for python-virtualenv.
 
 Default value: $python::params::virtualenv
 
 ##### `gunicorn`
 
 Data type: `Enum['absent', 'present', 'latest']`
 
-Desired installation state for Gunicorn. Boolean values are deprecated.
-Allowed values: 'absent', 'present', 'latest'
+Desired installation state for Gunicorn.
 
 Default value: $python::params::gunicorn
 
 ##### `manage_gunicorn`
 
 Data type: `Boolean`
 
-Allow Installation / Removal of Gunicorn. Default: true
+Allow Installation / Removal of Gunicorn.
 
 Default value: $python::params::manage_gunicorn
 
@@ -116,7 +117,6 @@ Default value: $python::params::manage_gunicorn
 Data type: `Optional[Enum['pip', 'scl', 'rhscl', 'anaconda', '']]`
 
 What provider to use for installation of the packages, except gunicorn and Python itself.
-Allowed values: 'pip'
 
 Default value: $python::params::provider
 
@@ -220,22 +220,6 @@ Optionally installs the gunicorn service
 include python::config
 ```
 
-### python::install
-
-Installs core python packages
-
-#### Examples
-
-##### 
-
-```puppet
-include python::install
-```
-
-### python::params
-
-The python Module default configuration settings.
-
 ## Defined types
 
 ### python::dotfile
@@ -375,10 +359,9 @@ Default value: `false`
 
 ##### `mode`
 
-Data type: `Any`
+Data type: `Enum['wsgi', 'django']`
 
 Gunicorn mode.
-wsgi|django. Default: wsgi
 
 Default value: 'wsgi'
 
@@ -413,27 +396,22 @@ Default value: `false`
 Data type: `Any`
 
 Set the application module name for gunicorn to load when not using Django.
-Default: app:app
 
 Default value: 'app:app'
 
 ##### `osenv`
 
 Data type: `Any`
 
-Allows setting environment variables for the gunicorn service. Accepts a
-hash of 'key': 'value' pairs.
-Default: false
+Allows setting environment variables for the gunicorn service. Accepts a hash of 'key': 'value' pairs.
 
 Default value: `false`
 
 ##### `timeout`
 
 Data type: `Any`
 
-Allows setting the gunicorn idle worker process time before being killed.
-The unit of time is seconds.
-Default: 30
+Allows setting the gunicorn idle worker process time before being killed. The unit of time is seconds.
 
 Default value: 30
 
@@ -723,7 +701,7 @@ Default value: present
 
 Data type: `Any`
 
-Python version to use. Default: system default
+Python version to use.
 
 Default value: 'system'
 
@@ -771,7 +749,7 @@ Default value: '0755'
 
 Data type: `Any`
 
-Specifies the PATH variable. Default: [ '/bin', '/usr/bin', '/usr/sbin' ]
+Specifies the PATH variable.
 
 Default value: [ '/bin', '/usr/bin', '/usr/sbin', '/usr/local/bin' ]
 

manifests/gunicorn.pp

@@ -6,20 +6,14 @@
 # @param manage_config_dir Set if the gunicorn config directory should be created. Default: false
 # @param virtualenv Run in virtualenv, specify directory. Default: disabled
 # @param mode Gunicorn mode.
-#  wsgi|django. Default: wsgi
 # @param dir Application directory.
 # @param bind Bind on: 'HOST', 'HOST:PORT', 'unix:PATH'.
 #  Default: system-wide: unix:/tmp/gunicorn-$name.socket
 #           virtualenv:  unix:${virtualenv}/${name}.socket
 # @param environment Set ENVIRONMENT variable. Default: none
 # @param appmodule Set the application module name for gunicorn to load when not using Django.
-#  Default: app:app
-# @param osenv Allows setting environment variables for the gunicorn service. Accepts a
-#  hash of 'key': 'value' pairs.
-#  Default: false
-# @param timeout Allows setting the gunicorn idle worker process time before being killed.
-#  The unit of time is seconds.
-#  Default: 30
+# @param osenv Allows setting environment variables for the gunicorn service. Accepts a hash of 'key': 'value' pairs.
+# @param timeout Allows setting the gunicorn idle worker process time before being killed. The unit of time is seconds.
 # @param template Which ERB template to use. Default: python/gunicorn.erb
 # @param args Custom arguments to add in gunicorn config file. Default: []
 #
@@ -40,26 +34,26 @@
 #  }
 #
 define python::gunicorn (
-  $ensure            = present,
-  $config_dir        = '/etc/gunicorn.d',
-  $manage_config_dir = false,
-  $virtualenv        = false,
-  $mode              = 'wsgi',
-  $dir               = false,
-  $bind              = false,
-  $environment       = false,
-  $owner             = 'www-data',
-  $group             = 'www-data',
-  $appmodule         = 'app:app',
-  $osenv             = false,
-  $timeout           = 30,
-  $workers           = false,
-  $access_log_format = false,
-  $accesslog         = false,
-  $errorlog          = false,
-  $log_level          = 'error',
-  $template          = 'python/gunicorn.erb',
-  $args              = [],
+  $ensure                       = present,
+  $config_dir                   = '/etc/gunicorn.d',
+  $manage_config_dir            = false,
+  $virtualenv                   = false,
+  Enum['wsgi', 'django'] $mode  = 'wsgi',
+  $dir                          = false,
+  $bind                         = false,
+  $environment                  = false,
+  $owner                        = 'www-data',
+  $group                        = 'www-data',
+  $appmodule                    = 'app:app',
+  $osenv                        = false,
+  $timeout                      = 30,
+  $workers                      = false,
+  $access_log_format            = false,
+  $accesslog                    = false,
+  $errorlog                     = false,
+  $log_level                     = 'error',
+  $template                     = 'python/gunicorn.erb',
+  $args                         = [],
 ) {
 
   # Parameter validation

manifests/init.pp

@@ -10,17 +10,12 @@
 #      - 'pypy' actually lets us use pypy as python.
 #      - 3/3.3/... means you are going to install the python3/python3.3/...
 #        package, if available on your osfamily.
-# @param pip  Desired installation state for python-pip. Boolean values are deprecated.
-#  Allowed values: 'absent', 'present', 'latest'
-# @param dev Desired installation state for python-dev. Boolean values are deprecated.
-#  Allowed values: 'absent', 'present', 'latest'
-# @param virtualenv Desired installation state for python-virtualenv. Boolean values are deprecated
-#  Allowed values: 'absent', 'present', 'latest
-# @param gunicorn Desired installation state for Gunicorn. Boolean values are deprecated.
-#  Allowed values: 'absent', 'present', 'latest'
-# @param manage_gunicorn Allow Installation / Removal of Gunicorn. Default: true
+# @param pip Desired installation state for python-pip.
+# @param dev Desired installation state for python-dev.
+# @param virtualenv Desired installation state for python-virtualenv.
+# @param gunicorn Desired installation state for Gunicorn.
+# @param manage_gunicorn Allow Installation / Removal of Gunicorn.
 # @param provider What provider to use for installation of the packages, except gunicorn and Python itself.
-#  Allowed values: 'pip'
 # @param use_epel to determine if the epel class is used.
 #
 # @example ensure system python is installed, with pip,dev, virtualenv, and gunicorn packages present
@@ -36,7 +31,7 @@
   Enum['absent', 'present', 'latest'] $ensure     = $python::params::ensure,
   $version                                        = $python::params::version,
   Enum['absent', 'present', 'latest'] $pip        = $python::params::pip,
-  $dev                                            = $python::params::dev,
+  Enum['absent', 'present', 'latest'] $dev        = $python::params::dev,
   Enum['absent', 'present', 'latest'] $virtualenv = $python::params::virtualenv,
   Enum['absent', 'present', 'latest'] $gunicorn   = $python::params::gunicorn,
   Boolean $manage_gunicorn                        = $python::params::manage_gunicorn,

manifests/install.pp

@@ -1,4 +1,4 @@
-#
+# @api private
 # @summary Installs core python packages
 #
 # @example

manifests/params.pp

@@ -1,4 +1,4 @@
-#
+# @api private
 # @summary The python Module default configuration settings.
 #
 class python::params {

manifests/pyvenv.pp

@@ -2,13 +2,13 @@
 # @summary Create a Python3 virtualenv using pyvenv.
 #
 # @param ensure
-# @param version Python version to use. Default: system default
+# @param version Python version to use.
 # @param systempkgs Copy system site-packages into virtualenv
 # @param venv_dir  Directory to install virtualenv to
 # @param owner The owner of the virtualenv being manipulated
 # @param group The group relating to the virtualenv being manipulated
 # @param mode  Optionally specify directory mode
-# @param path Specifies the PATH variable. Default: [ '/bin', '/usr/bin', '/usr/sbin' ]
+# @param path Specifies the PATH variable.
 # @param environment Optionally specify environment variables for pyvenv
 #
 # @example