Merge pull request #1006 from puppetlabs/release-prep

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

diff --git a/manifests/conf.pp b/manifests/conf.pp
index f41501b5d189a64830e7a4c0cbcd1729ca892e87..c27f0c1c0dcd683699caec9572739157468a57d7 100644 (file)
--- a/manifests/conf.pp
+++ b/manifests/conf.pp
@@ -1,4 +1,18 @@
-# Defining apt config
+# @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,
@@ -8,7 +22,7 @@ define apt::conf (
 
   unless $ensure == 'absent' {
     unless $content {
-      fail(translate('Need to pass in content parameter'))
+      fail('Need to pass in content parameter')
     }
   }