More consist descriptions for resource name properties

This better describes how a name property works.

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

23 files changed, 24 insertions, 24 deletions

diff --git a/lib/chef/resource/dmg_package.rb b/lib/chef/resource/dmg_package.rb
index e6695ac5e3..9d84299a2e 100644
--- a/lib/chef/resource/dmg_package.rb
+++ b/lib/chef/resource/dmg_package.rb
@@ -27,7 +27,7 @@ class Chef
       introduced "14.0"
 
       property :app, String,
-               description: "The name of the application as it appears in the /Volumes directory, if it differs from the resource block's name.",
+               description: "The name of the application as it appears in the /Volumes directory if it differs from the resource block's name.",
                name_property: true
 
       property :source, String,
@@ -47,7 +47,7 @@ class Chef
                description: "The sha256 checksum of the .dmg file to download."
 
       property :volumes_dir, String,
-               description: "The directory under /Volumes where the dmg is mounted, if it differs from the name of the .dmg file.",
+               description: "The directory under /Volumes where the dmg is mounted if it differs from the name of the .dmg file.",
                default: lazy { |r| r.app }, default_description: "The value passed for the application name."
 
       property :dmg_name, String,
diff --git a/lib/chef/resource/sudo.rb b/lib/chef/resource/sudo.rb
index 9ace6ee359..74dd9d1a55 100644
--- a/lib/chef/resource/sudo.rb
+++ b/lib/chef/resource/sudo.rb
@@ -37,7 +37,7 @@ class Chef
       # acording to the sudo man pages sudo will ignore files in an include dir that have a `.` or `~`
       # We convert either to `__`
       property :filename, String,
-               description: "The name of the sudoers.d file, if it differs from the name of the resource block",
+               description: "The name of the sudoers.d file if it differs from the name of the resource block",
                name_property: true,
                coerce: proc { |x| x.gsub(/[\.~]/, "__") }
 
diff --git a/lib/chef/resource/swap_file.rb b/lib/chef/resource/swap_file.rb
index f4f95cb28c..93c3f0906b 100644
--- a/lib/chef/resource/swap_file.rb
+++ b/lib/chef/resource/swap_file.rb
@@ -27,7 +27,7 @@ class Chef
       introduced "14.0"
 
       property :path, String,
-               description: "The path where the swap file will be created on the system, if it differs from the resource block's name.",
+               description: "The path where the swap file will be created on the system if it differs from the resource block's name.",
                name_property: true
 
       property :size, Integer,
diff --git a/lib/chef/resource/sysctl.rb b/lib/chef/resource/sysctl.rb
index 53dfb0663e..08f4bf716c 100644
--- a/lib/chef/resource/sysctl.rb
+++ b/lib/chef/resource/sysctl.rb
@@ -33,7 +33,7 @@ class Chef
       introduced "14.0"
 
       property :key, String,
-               description: "The kernel parameter key in dotted format, if it differs from the resource block's name.",
+               description: "The kernel parameter key in dotted format if it differs from the resource block's name.",
                name_property: true
 
       property :ignore_error, [TrueClass, FalseClass],
diff --git a/lib/chef/resource/timezone.rb b/lib/chef/resource/timezone.rb
index 4be52f305a..37be0918bb 100644
--- a/lib/chef/resource/timezone.rb
+++ b/lib/chef/resource/timezone.rb
@@ -29,7 +29,7 @@ class Chef
       introduced "14.6"
 
       property :timezone, String,
-               description: "The timezone value to set.",
+               description: "An optional property to set the timezone value if it differs from the resource block's name.",
                name_property: true
 
       action :set do
diff --git a/lib/chef/resource/windows_ad_join.rb b/lib/chef/resource/windows_ad_join.rb
index 50e71ef362..3b0ae343a9 100644
--- a/lib/chef/resource/windows_ad_join.rb
+++ b/lib/chef/resource/windows_ad_join.rb
@@ -30,7 +30,7 @@ class Chef
       introduced "14.0"
 
       property :domain_name, String,
-               description: "The FQDN of the Active Directory domain to join.",
+               description: "The FQDN of the Active Directory domain to join if it differs from the resource block's name.",
                validation_message: "The 'domain_name' property must be a FQDN.",
                regex: /.\../, # anything.anything
                name_property: true
diff --git a/lib/chef/resource/windows_auto_run.rb b/lib/chef/resource/windows_auto_run.rb
index 74c3d85520..34f3443323 100644
--- a/lib/chef/resource/windows_auto_run.rb
+++ b/lib/chef/resource/windows_auto_run.rb
@@ -28,7 +28,7 @@ class Chef
       introduced "14.0"
 
       property :program_name, String,
-               description: "The name of the program to run at login, if it differs from the resource block's name.",
+               description: "The name of the program to run at login if it differs from the resource block's name.",
                name_property: true
 
       property :path, String,
diff --git a/lib/chef/resource/windows_certificate.rb b/lib/chef/resource/windows_certificate.rb
index 0dc8ee31b2..ba942328d3 100644
--- a/lib/chef/resource/windows_certificate.rb
+++ b/lib/chef/resource/windows_certificate.rb
@@ -32,7 +32,7 @@ class Chef
       introduced "14.7"
 
       property :source, String,
-               description: "The source file (for create and acl_add), thumbprint (for delete and acl_add) or subject (for delete).",
+               description: "The source file (for create and acl_add), thumbprint (for delete and acl_add) or subject (for delete) if it differs from the resource block's name.",
                name_property: true
 
       property :pfx_password, String,
diff --git a/lib/chef/resource/windows_env.rb b/lib/chef/resource/windows_env.rb
index e08ae596a9..f67013965b 100644
--- a/lib/chef/resource/windows_env.rb
+++ b/lib/chef/resource/windows_env.rb
@@ -32,7 +32,7 @@ class Chef
       allowed_actions :create, :delete, :modify
 
       property :key_name, String,
-               description: "The name of the key that is to be created, deleted, or modified.",
+               description: "An optional property to set the name of the key that is to be created, deleted, or modified if it differs from the resource block's name.",
                identity: true, name_property: true
 
       property :value, String,
diff --git a/lib/chef/resource/windows_feature.rb b/lib/chef/resource/windows_feature.rb
index 24f555a86c..6641242148 100644
--- a/lib/chef/resource/windows_feature.rb
+++ b/lib/chef/resource/windows_feature.rb
@@ -28,7 +28,7 @@ class Chef
       introduced "14.0"
 
       property :feature_name, [Array, String],
-               description: "The name of the feature(s) or role(s) to install, if it differs from the resource block's name. The same feature may have different names depending on the underlying installation method being used (ie DHCPServer vs DHCP; DNS-Server-Full-Role vs DNS).",
+               description: "The name of the feature(s) or role(s) to install if they differ from the resource block's name. The same feature may have different names depending on the underlying installation method being used (ie DHCPServer vs DHCP; DNS-Server-Full-Role vs DNS).",
                name_property: true
 
       property :source, String,
diff --git a/lib/chef/resource/windows_feature_dism.rb b/lib/chef/resource/windows_feature_dism.rb
index 214ad5bedd..b6bd4ccb8a 100644
--- a/lib/chef/resource/windows_feature_dism.rb
+++ b/lib/chef/resource/windows_feature_dism.rb
@@ -29,7 +29,7 @@ class Chef
       introduced "14.0"
 
       property :feature_name, [Array, String],
-               description: "The name of the feature(s) or role(s) to install, if it differs from the resource name.",
+               description: "The name of the feature(s) or role(s) to install if they differ from the resource name.",
                coerce: proc { |x| to_formatted_array(x) },
                name_property: true
 
diff --git a/lib/chef/resource/windows_feature_powershell.rb b/lib/chef/resource/windows_feature_powershell.rb
index 9a7b725575..a0d4c1ae64 100644
--- a/lib/chef/resource/windows_feature_powershell.rb
+++ b/lib/chef/resource/windows_feature_powershell.rb
@@ -31,7 +31,7 @@ class Chef
       introduced "14.0"
 
       property :feature_name, [Array, String],
-               description: "The name of the feature(s) or role(s) to install, if it differs from the resource block's name.",
+               description: "The name of the feature(s) or role(s) to install if they differ from the resource block's name.",
                coerce: proc { |x| to_formatted_array(x) },
                name_property: true
 
diff --git a/lib/chef/resource/windows_firewall_rule.rb b/lib/chef/resource/windows_firewall_rule.rb
index 271b9fcc41..260c15b021 100644
--- a/lib/chef/resource/windows_firewall_rule.rb
+++ b/lib/chef/resource/windows_firewall_rule.rb
@@ -32,7 +32,7 @@ class Chef
 
       property :rule_name, String,
                name_property: true,
-               description: "The name to assign to the firewall rule."
+               description: "An optional property to set the name of the firewall rule to assign if it differs from the resource block's name."
 
       property :description, String,
                default: "Firewall rule",
diff --git a/lib/chef/resource/windows_font.rb b/lib/chef/resource/windows_font.rb
index 4c895321c0..5657bce390 100644
--- a/lib/chef/resource/windows_font.rb
+++ b/lib/chef/resource/windows_font.rb
@@ -29,7 +29,7 @@ class Chef
       introduced "14.0"
 
       property :font_name, String,
-               description: "The name of the font file to install, if it differs from the resource name.",
+               description: "An optional property to set the name of the font to install if it differs from the resource block's name.",
                name_property: true
 
       property :source, String,
diff --git a/lib/chef/resource/windows_pagefile.rb b/lib/chef/resource/windows_pagefile.rb
index 9c77c1f560..a41e598bd9 100644
--- a/lib/chef/resource/windows_pagefile.rb
+++ b/lib/chef/resource/windows_pagefile.rb
@@ -28,7 +28,7 @@ class Chef
 
       property :path, String,
                coerce: proc { |x| x.tr("/", '\\') },
-               description: "The path to the pagefile if different from the resource name.",
+               description: "An optional property to set the pagefile name if it differs from the resource block's name.",
                name_property: true
 
       property :system_managed, [TrueClass, FalseClass],
diff --git a/lib/chef/resource/windows_path.rb b/lib/chef/resource/windows_path.rb
index 7f2e79d9d2..e0af92f551 100644
--- a/lib/chef/resource/windows_path.rb
+++ b/lib/chef/resource/windows_path.rb
@@ -31,7 +31,7 @@ class Chef
       default_action :add
 
       property :path, String,
-               description: "The name of the value to add to the system path",
+               description: "An optional property to set the path value if it differs from the resource block's name.",
                name_property: true
     end
   end
diff --git a/lib/chef/resource/windows_printer.rb b/lib/chef/resource/windows_printer.rb
index 8ddb085ee3..b5c963c85b 100644
--- a/lib/chef/resource/windows_printer.rb
+++ b/lib/chef/resource/windows_printer.rb
@@ -31,7 +31,7 @@ class Chef
       introduced "14.0"
 
       property :device_id, String,
-               description: "Printer queue name, such as 'HP LJ 5200 in fifth floor copy room'.",
+               description: "An optional property to set the printer queue name if it differs from the resource block's name. Example: 'HP LJ 5200 in fifth floor copy room'.",
                name_property: true
 
       property :comment, String,
diff --git a/lib/chef/resource/windows_share.rb b/lib/chef/resource/windows_share.rb
index 1fda67e820..46508ba5c9 100644
--- a/lib/chef/resource/windows_share.rb
+++ b/lib/chef/resource/windows_share.rb
@@ -33,7 +33,7 @@ class Chef
 
       # Specifies a name for the SMB share. The name may be composed of any valid file name characters, but must be less than 80 characters long. The names pipe and mailslot are reserved for use by the computer.
       property :share_name, String,
-               description: "The name to assign to the share.",
+               description: "An optional property to set the share name if it differs from the resource block's name.",
                name_property: true
 
       # Specifies the path of the location of the folder to share. The path must be fully qualified. Relative paths or paths that contain wildcard characters are not permitted.
diff --git a/lib/chef/resource/windows_shortcut.rb b/lib/chef/resource/windows_shortcut.rb
index 7f7cfd3fe9..34e080283b 100644
--- a/lib/chef/resource/windows_shortcut.rb
+++ b/lib/chef/resource/windows_shortcut.rb
@@ -28,7 +28,7 @@ class Chef
       introduced "14.0"
 
       property :shortcut_name, String,
-               description: "The name for the shortcut, if it differs from the resource name.",
+               description: "An optional property to set the shortcut name if it differs from the resource block's name.",
                name_property: true
 
       property :target, String,
diff --git a/lib/chef/resource/windows_task.rb b/lib/chef/resource/windows_task.rb
index f664fc57be..54920f2bac 100644
--- a/lib/chef/resource/windows_task.rb
+++ b/lib/chef/resource/windows_task.rb
@@ -32,7 +32,7 @@ class Chef
       default_action :create
 
       property :task_name, String, regex: [/\A[^\/\:\*\?\<\>\|]+\z/],
-               description: "The task name, such as 'Task Name' or '/Task Name'",
+               description: "An optional property to set the task name if it differs from the resource block's name. Example: 'Task Name' or '/Task Name'",
                name_property: true
 
       property :command, String,
diff --git a/lib/chef/resource/windows_workgroup.rb b/lib/chef/resource/windows_workgroup.rb
index 2aeb534074..6bf6e96d18 100644
--- a/lib/chef/resource/windows_workgroup.rb
+++ b/lib/chef/resource/windows_workgroup.rb
@@ -30,7 +30,7 @@ class Chef
       introduced "14.5"
 
       property :workgroup_name, String,
-               description: "The name of the workgroup for the computer.",
+               description: "An optional property to set the workgroup name if it differs from the resource block's name.",
                validation_message: "The 'workgroup_name' property must not contain spaces.",
                regex: /^\S*$/, # no spaces
                name_property: true
diff --git a/lib/chef/resource/yum_repository.rb b/lib/chef/resource/yum_repository.rb
index f3d73bff53..0a9747c266 100644
--- a/lib/chef/resource/yum_repository.rb
+++ b/lib/chef/resource/yum_repository.rb
@@ -143,7 +143,7 @@ class Chef
                description: "Determines whether to report the instance ID when using Amazon Linux AMIs and repositories."
 
       property :repositoryid, String, regex: [/^[^\/]+$/],
-               description: "Specifies a unique name for each repository, one word. Defaults to name property.",
+               description: "An optional property to set the repository name if it differs from the resource block's name.",
                validation_message: "repositoryid property cannot contain a forward slash '/'",
                name_property: true
 
diff --git a/lib/chef/resource/zypper_repository.rb b/lib/chef/resource/zypper_repository.rb
index e4db20d446..d1683d5fd0 100644
--- a/lib/chef/resource/zypper_repository.rb
+++ b/lib/chef/resource/zypper_repository.rb
@@ -30,7 +30,7 @@ class Chef
 
       property :repo_name, String,
                regex: [/^[^\/]+$/],
-               description: "Specifies the repository name, if it differs from the resource name.",
+               description: "An optional property to set the repository name if it differs from the resource block's name.",
                validation_message: "repo_name property cannot contain a forward slash '/'",
                name_property: true