"This change pins the puppetlabs-puppet_agent module to v4.12.1. Previosuly the fixut...

[puppet-modules/puppetlabs-apt.git] / manifests / conf.pp

diff --git a/manifests/conf.pp b/manifests/conf.pp
index eea06861d9e3793e807a9e77d5388d0897941d3c..0aec66dd63f69f5bb68195e4f9f6120c0c6332ae 100644 (file)
--- a/manifests/conf.pp
+++ b/manifests/conf.pp
@@ -1,10 +1,24 @@
+# @summary Specifies a custom Apt configuration file.
+#
+# @param content
+#   Required unless `ensure` is set to 'absent'. Directly supplies content for the configuration file.
+#
+# @param ensure
+#    Specifies whether the configuration file should exist. Valid options: 'present' and 'absent'. 
+#
+# @param priority
+#   Determines the order in which Apt processes the configuration file. Files with lower priority numbers are loaded first. 
+#   Valid options: a string containing an integer or an integer.
+#
+# @param notify_update
+#   Specifies whether to trigger an `apt-get update` run.
+#
 define apt::conf (
   Optional[String] $content          = undef,
   Enum['present', 'absent'] $ensure  = present,
   Variant[String, Integer] $priority = 50,
   Optional[Boolean] $notify_update   = undef,
 ) {
-
   unless $ensure == 'absent' {
     unless $content {
       fail('Need to pass in content parameter')