Add a description field to yum_package

Signed-off-by: Tim Smith <tsmith@chef.io>

1 files changed, 6 insertions, 0 deletions

diff --git a/lib/chef/resource/yum_package.rb b/lib/chef/resource/yum_package.rb
index f066e3f0ad..905cacc477 100644
--- a/lib/chef/resource/yum_package.rb
+++ b/lib/chef/resource/yum_package.rb
@@ -24,6 +24,12 @@ class Chef
       resource_name :yum_package
       provides :package, platform_family: %w{rhel fedora amazon}
 
+      description "Use the yum_package resource to install, upgrade, and remove packages with Yum"\
+                  " for the Red Hat and CentOS platforms. The yum_package resource is able to resolve"\
+                  " provides data for packages much like Yum can do when it is run from the command line."\
+                  " This allows a variety of options for installing packages, like minimum versions,"\
+                  " virtual provides, and library names."
+
       # XXX: the coercions here are due to the provider promiscuously updating the properties on the
       # new_resource which causes immutable modification exceptions when passed an immutable node array.
       #