Merge pull request #7784 from chef/descriptions

Update description fields from the docs site

8 files changed, 17 insertions, 17 deletions

diff --git a/lib/chef/resource/dmg_package.rb b/lib/chef/resource/dmg_package.rb
index 7442a8f455..f697d8303b 100644
--- a/lib/chef/resource/dmg_package.rb
+++ b/lib/chef/resource/dmg_package.rb
@@ -75,7 +75,7 @@ class Chef
                default: nil
 
       property :allow_untrusted, [TrueClass, FalseClass],
-               description: "Allows packages with untrusted certs to be installed.",
+               description: "Allow installation of packages that do not have trusted certificates.",
                default: false
 
       load_current_value do |new_resource|
diff --git a/lib/chef/resource/group.rb b/lib/chef/resource/group.rb
index fc2c33322b..2f8406faf4 100644
--- a/lib/chef/resource/group.rb
+++ b/lib/chef/resource/group.rb
@@ -36,7 +36,7 @@ class Chef
 
       property :members, [String, Array], default: lazy { [] },
                coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
-               description: "Which users should be set or appended to a group. This can be either an array or a comma separated list."
+               description: "Which users should be set or appended to a group. When more than one group member is identified, the list of members should be an array: members ['user1', 'user2']."
 
       property :excluded_members, [String, Array], default: lazy { [] },
                coerce: proc { |arg| arg.is_a?(String) ? arg.split(/\s*,\s*/) : arg },
@@ -46,7 +46,7 @@ class Chef
                description: "How members should be appended and/or removed from a group. When true, members are appended and excluded_members are removed. When false, group members are reset to the value of the members property."
 
       property :system, [ TrueClass, FalseClass ], default: false,
-               description: "Sets the group to belong to the system group."
+               description: "Set if a group belongs to a system group. Set to true if the group belongs to a system group."
 
       property :non_unique, [ TrueClass, FalseClass ], default: false,
                description: "Allow gid duplication. May only be used with the Groupadd provider."
diff --git a/lib/chef/resource/homebrew_cask.rb b/lib/chef/resource/homebrew_cask.rb
index 5789570b01..626ae02a69 100644
--- a/lib/chef/resource/homebrew_cask.rb
+++ b/lib/chef/resource/homebrew_cask.rb
@@ -37,7 +37,7 @@ class Chef
                name_property: true
 
       property :options, String,
-               description: "Options to pass to the brew CLI during installation."
+               description: "Options to pass to the brew command during installation."
 
       property :install_cask, [TrueClass, FalseClass],
                description: "Automatically install the Homebrew cask tap, if necessary.",
@@ -48,7 +48,7 @@ class Chef
                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 :install do
diff --git a/lib/chef/resource/homebrew_tap.rb b/lib/chef/resource/homebrew_tap.rb
index 6f239e9482..20ac0bb5d5 100644
--- a/lib/chef/resource/homebrew_tap.rb
+++ b/lib/chef/resource/homebrew_tap.rb
@@ -38,7 +38,7 @@ class Chef
                name_property: true
 
       property :url, String,
-               description: "URL to the tap."
+               description: "The URL of the tap."
 
       property :full, [TrueClass, FalseClass],
                description: "Perform a full clone on the tap, as opposed to a shallow clone.",
diff --git a/lib/chef/resource/hostname.rb b/lib/chef/resource/hostname.rb
index 23111d0b92..30446fbead 100644
--- a/lib/chef/resource/hostname.rb
+++ b/lib/chef/resource/hostname.rb
@@ -27,7 +27,7 @@ class Chef
       introduced "14.0"
 
       property :hostname, String,
-               description: "Used to specify the hostname if it is 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 ],
diff --git a/lib/chef/resource/macos_userdefaults.rb b/lib/chef/resource/macos_userdefaults.rb
index f2ad5a0213..9c1acc3334 100644
--- a/lib/chef/resource/macos_userdefaults.rb
+++ b/lib/chef/resource/macos_userdefaults.rb
@@ -29,11 +29,11 @@ class Chef
       introduced "14.0"
 
       property :domain, String,
-               description: "The domain the defaults belong to.",
+               description: "The domain that the user defaults belong to.",
                required: true
 
       property :global, [TrueClass, FalseClass],
-               description: "Whether the domain is global.",
+               description: "Determines whether or not the domain is global.",
                default: false
 
       property :key, String,
@@ -44,14 +44,14 @@ class Chef
                required: true
 
       property :type, String,
-               description: "Value type of the preference key.",
+               description: "The value type of the preference key.",
                default: ""
 
       property :user, String,
-               description: "User for which to set the default."
+               description: "The system user that the default will be applied to."
 
       property :sudo, [TrueClass, FalseClass],
-               description: "Set to true if the setting requires privileged access to modify.",
+               description: "Set to true if the setting you wish to modify requires privileged access.",
                default: false,
                desired_state: false
 
diff --git a/lib/chef/resource/openssl_ec_public_key.rb b/lib/chef/resource/openssl_ec_public_key.rb
index 51eb4c93a2..4019c7e94a 100644
--- a/lib/chef/resource/openssl_ec_public_key.rb
+++ b/lib/chef/resource/openssl_ec_public_key.rb
@@ -26,7 +26,7 @@ class Chef
 
       resource_name :openssl_ec_public_key
 
-      description "Use the openssl_ec_public_key resource to generate elliptic curve (EC) public key files given a private key."
+      description "Use the openssl_ec_public_key resource to generate elliptic curve (EC) public key files from a given EC private key."
       introduced "14.4"
 
       property :path, String,
@@ -37,7 +37,7 @@ class Chef
                description: "The path to the private key file."
 
       property :private_key_content, String,
-               description: "The content of the private key including new lines. This property is used in place of private_key_path to avoid having to first write a key to disk."
+               description: "The content of the private key including new lines. This property is used in place of private_key_path in instances where you want to avoid having to first write the private key to disk"
 
       property :private_key_pass, String,
                description: "The passphrase of the provided private key."
diff --git a/lib/chef/resource/openssl_rsa_public_key.rb b/lib/chef/resource/openssl_rsa_public_key.rb
index c213284235..b9a4924c3e 100644
--- a/lib/chef/resource/openssl_rsa_public_key.rb
+++ b/lib/chef/resource/openssl_rsa_public_key.rb
@@ -26,18 +26,18 @@ class Chef
       resource_name :openssl_rsa_public_key
       provides(:openssl_rsa_public_key) { true }
 
-      description "Use the openssl_rsa_public_key resource to generate RSA public key files given a RSA private key."
+      description "Use the openssl_rsa_public_key resource to generate RSA public key files for a given RSA private key."
       introduced "14.0"
 
       property :path, String,
-               description: "The path to write the file to if different than the resource's name.",
+               description: "The path to the public key file, if it differs from the resource name.",
                name_property: true
 
       property :private_key_path, String,
                description: "The path to the private key file."
 
       property :private_key_content, String,
-               description: "The content of the private key including new lines. This property is used in place of private_key_path to avoid having to first write a key to disk."
+               description: "The content of the private key, including new lines. This property is used in place of private_key_path in instances where you want to avoid having to first write the private key to disk."
 
       property :private_key_pass, String,
                description: "The passphrase of the provided private key."