summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2019-04-29 14:25:09 -0700
committerTim Smith <tsmith@chef.io>2019-04-29 14:44:33 -0700
commit4a61860ad9f298645e6c0573c126b092af64bac1 (patch)
treebb61a70da73a359f34913247c2b6883c5c83c2b2
parent945b9f6636bb3236999ca43f313113bf74045d82 (diff)
downloadchef-4a61860ad9f298645e6c0573c126b092af64bac1.tar.gz
Update property descriptions for new resources
The docs team performed copy editing on these on the docs site. This backports those changes. Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/archive_file.rb4
-rw-r--r--lib/chef/resource/windows_dfs_namespace.rb8
-rw-r--r--lib/chef/resource/windows_dns_zone.rb2
3 files changed, 7 insertions, 7 deletions
diff --git a/lib/chef/resource/archive_file.rb b/lib/chef/resource/archive_file.rb
index bf057727b5..f6adfda083 100644
--- a/lib/chef/resource/archive_file.rb
+++ b/lib/chef/resource/archive_file.rb
@@ -51,11 +51,11 @@ class Chef
required: true
property :options, [Array, Symbol],
- description: "An array of symbols representing extraction flags. Example: :no_overwrite to prevent overwriting files on disk. By default this properly sets :time which preserves the modification timestamps of files in the archive when writing them to disk.",
+ description: "An array of symbols representing extraction flags. Example: :no_overwrite to prevent overwriting files on disk. By default, this properly sets :time which preserves the modification timestamps of files in the archive when writing them to disk.",
default: lazy { [:time] }
property :overwrite, [TrueClass, FalseClass, :auto],
- description: "Should the resource overwrite the destination file contents if they already exist? If set to :auto the date stamp of files within the archive will be compared to those on disk and disk contents will be overwritten if they differ. This may cause unintented consequences if on disk date stamps are changed between runs, which will result in the files being overwritten during each client run. Make sure to properly test any change to this property.",
+ description: "Should the resource overwrite the destination file contents if they already exist? If set to :auto the date stamp of files within the archive will be compared to those on disk and disk contents will be overwritten if they differ. This may cause unintended consequences if disk date stamps are changed between runs, which will result in the files being overwritten during each client run. Make sure to properly test any change to this property.",
default: false
# backwards compatibility for the legacy cookbook names
diff --git a/lib/chef/resource/windows_dfs_namespace.rb b/lib/chef/resource/windows_dfs_namespace.rb
index 45d61a2072..fe168f25ce 100644
--- a/lib/chef/resource/windows_dfs_namespace.rb
+++ b/lib/chef/resource/windows_dfs_namespace.rb
@@ -36,19 +36,19 @@ class Chef
required: true
property :full_users, Array,
- description: "Which users should have full access to the share.",
+ description: "Determines which users should have full access to the share.",
default: ['BUILTIN\\administrators']
property :change_users, Array,
- description: " Which users should have change access to the share.",
+ description: "Determines which users should have change access to the share.",
default: []
property :read_users, Array,
- description: "Which users should have read access to the share.",
+ description: "Determines which users should have read access to the share.",
default: []
property :root, String,
- description: "The root from which to create the DFS tree, defaults to C:\\DFSRoots.",
+ description: "The root from which to create the DFS tree. Defaults to C:\\DFSRoots.",
default: 'C:\\DFSRoots'
action :install do
diff --git a/lib/chef/resource/windows_dns_zone.rb b/lib/chef/resource/windows_dns_zone.rb
index 5be12923d8..391d05757a 100644
--- a/lib/chef/resource/windows_dns_zone.rb
+++ b/lib/chef/resource/windows_dns_zone.rb
@@ -32,7 +32,7 @@ class Chef
name_property: true
property :replication_scope, String,
- description: "The replication scope for the zone, required if server_type set to 'Domain'",
+ description: "The replication scope for the zone, required if server_type set to 'Domain'.",
default: "Domain"
property :server_type, String,