(FM-7318) - Added Puppet Strings formatting to documentation

[puppet-modules/puppetlabs-apt.git] / lib / facter / apt_updates.rb

diff --git a/lib/facter/apt_updates.rb b/lib/facter/apt_updates.rb
index cf7d12f4c2d2e2593d95a9e93f45a01e0314fde6..7a701c17a01f849ec05a4954c604be2e591d04d1 100644 (file)
--- a/lib/facter/apt_updates.rb
+++ b/lib/facter/apt_updates.rb
@@ -1,6 +1,9 @@
 apt_package_updates = nil
 apt_dist_updates = nil
 
+# Executes the upgrading of packages
+# @param
+#   upgrade_option Type of upgrade passed into apt-get command arguments i.e. 'upgrade' or 'dist-upgrade'
 def get_updates(upgrade_option)
   apt_updates = nil
   if File.executable?('/usr/bin/apt-get')