More documentation updates for resources

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

4 files changed, 26 insertions, 7 deletions

diff --git a/lib/chef/resource/apt_package.rb b/lib/chef/resource/apt_package.rb
index 485210090d..4738d0cbbe 100644
--- a/lib/chef/resource/apt_package.rb
+++ b/lib/chef/resource/apt_package.rb
@@ -26,8 +26,13 @@ class Chef
 
       description "Use the apt_package resource to manage packages on Debian and Ubuntu platforms."
 
-      property :default_release, String, desired_state: false
-      property :overwrite_config_files, [TrueClass, FalseClass], default: false
+      property :default_release, String,
+               description: "The default release. For example: stable.",
+               desired_state: false
+
+      property :overwrite_config_files, [TrueClass, FalseClass],
+               description: "Overwrite existing config files with those in the package if prompted by apt.",
+               default: false
 
     end
   end
diff --git a/lib/chef/resource/apt_preference.rb b/lib/chef/resource/apt_preference.rb
index 442d85a78a..42e2c66aef 100644
--- a/lib/chef/resource/apt_preference.rb
+++ b/lib/chef/resource/apt_preference.rb
@@ -30,10 +30,21 @@ class Chef
                   " sources are prioritized during installation."
       introduced "13.3"
 
-      property :package_name, String, name_property: true, regex: [/^([a-z]|[A-Z]|[0-9]|_|-|\.|\*|\+)+$/]
-      property :glob, String
-      property :pin, String, required: true
-      property :pin_priority, [String, Integer], required: true
+      property :package_name, String,
+               name_property: true,
+               description: "The name of the package.",
+               regex: [/^([a-z]|[A-Z]|[0-9]|_|-|\.|\*|\+)+$/]
+
+      property :glob, String,
+               description: "Pin by glob() expression or with regular expressions surrounded by /."
+
+      property :pin, String,
+               description: "The package version or repository to pin.",
+               required: true
+
+      property :pin_priority, [String, Integer],
+               description: "Sets the Pin-Priority for a package.",
+               required: true
 
       default_action :add
       allowed_actions :add, :remove
diff --git a/lib/chef/resource/build_essential.rb b/lib/chef/resource/build_essential.rb
index 8977444692..7998006398 100644
--- a/lib/chef/resource/build_essential.rb
+++ b/lib/chef/resource/build_essential.rb
@@ -30,6 +30,9 @@ class Chef
                default: false
 
       action :install do
+
+        description "Install build essential packages"
+
         case node["platform_family"]
         when "debian"
           declare_resource(:package,  %w{ autoconf binutils-doc bison build-essential flex gettext ncurses-dev })
diff --git a/lib/chef/resource/openssl_rsa_private_key.rb b/lib/chef/resource/openssl_rsa_private_key.rb
index 352d802175..88e110d63b 100644
--- a/lib/chef/resource/openssl_rsa_private_key.rb
+++ b/lib/chef/resource/openssl_rsa_private_key.rb
@@ -40,7 +40,7 @@ class Chef
 
       property :key_length, Integer,
                equal_to: [1024, 2048, 4096, 8192],
-               validation_message: "key_length must be 1024, 2048, 4096, or 8192.",
+               validation_message: "key_length (bits) must be 1024, 2048, 4096, or 8192.",
                description: "The desired bit length of the generated key.",
                default: 2048