Merge pull request #7646 from chef/resource_doc_fixes

More Resource doc fixes

4 files changed, 12 insertions, 11 deletions

diff --git a/lib/chef/resource/homebrew_cask.rb b/lib/chef/resource/homebrew_cask.rb
index e45a5c4052..5789570b01 100644
--- a/lib/chef/resource/homebrew_cask.rb
+++ b/lib/chef/resource/homebrew_cask.rb
@@ -32,7 +32,7 @@ class Chef
       include Chef::Mixin::HomebrewUser
 
       property :cask_name, String,
-               description: "Cask name to override the resource name.",
+               description: "The name of the Homebrew cask, if it differs from the resource block name.",
                regex: %r{^[\w/-]+$},
                name_property: true
 
@@ -40,7 +40,7 @@ class Chef
                description: "Options to pass to the brew CLI during installation."
 
       property :install_cask, [TrueClass, FalseClass],
-               description: "Auto install cask tap if necessary.",
+               description: "Automatically install the Homebrew cask tap, if necessary.",
                default: true
 
       property :homebrew_path, String,
diff --git a/lib/chef/resource/homebrew_tap.rb b/lib/chef/resource/homebrew_tap.rb
index ab56f6a4c9..6f239e9482 100644
--- a/lib/chef/resource/homebrew_tap.rb
+++ b/lib/chef/resource/homebrew_tap.rb
@@ -41,15 +41,15 @@ class Chef
                description: "URL to the tap."
 
       property :full, [TrueClass, FalseClass],
-               description: "Perform a full clone rather than a shallow clone on the tap.",
+               description: "Perform a full clone on the tap, as opposed to a shallow clone.",
                default: false
 
       property :homebrew_path, String,
-               description: "The path to the homebrew binary.",
+               description: "The path to the Homebrew binary.",
                default: "/usr/local/bin/brew"
 
       property :owner, String,
-               description: "The owner of the homebrew installation.",
+               description: "The owner of the Homebrew installation.",
                default: lazy { find_homebrew_username }
 
       action :tap do
diff --git a/lib/chef/resource/hostname.rb b/lib/chef/resource/hostname.rb
index 82240bd6fb..23111d0b92 100644
--- a/lib/chef/resource/hostname.rb
+++ b/lib/chef/resource/hostname.rb
@@ -27,15 +27,15 @@ class Chef
       introduced "14.0"
 
       property :hostname, String,
-               description: "The hostname if different than the resource's name.",
+               description: "Used to specify the hostname if it is different than the resource’s name.",
                name_property: true
 
       property :compile_time, [ TrueClass, FalseClass ],
-               description: "Whether the resource runs at compile time or not.",
+               description: "Determines whether or not the resource shoul be run at compile time.",
                default: true
 
       property :ipaddress, String,
-               description: "The ip address to use when configuring the hosts file.",
+               description: "The IP address to use when configuring the hosts file.",
                default: lazy { node["ipaddress"] }
 
       property :aliases, [ Array, nil ],
@@ -43,7 +43,7 @@ class Chef
                default: nil
 
       property :windows_reboot, [ TrueClass, FalseClass ],
-               description: "Whether Windows nodes will be rebooted upon changing the name so changes can take effect.",
+               description: "Determines whether or not Windows should be reboot after changing the hostname, as this is required for the change to take effect.",
                default: true
 
       action_class do
diff --git a/lib/chef/resource/locale.rb b/lib/chef/resource/locale.rb
index 01a4577c43..bde1ee704e 100644
--- a/lib/chef/resource/locale.rb
+++ b/lib/chef/resource/locale.rb
@@ -23,7 +23,7 @@ class Chef
       preview_resource true
       resource_name :locale
 
-      description "Use the locale resource to set the system's locale"
+      description "Use the locale resource to set the system's locale."
       introduced "14.5"
 
       property :lang, String,
@@ -34,7 +34,8 @@ class Chef
                description: "Sets the fallback system language."
 
       action :update do
-        description "Updates the system locale"
+        description "Update the system's locale."
+
         if node["init_package"] == "systemd"
           # on systemd settings LC_ALL is (correctly) reserved only for testing and cannot be set globally
           execute "localectl set-locale LANG=#{new_resource.lang}" do