summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2020-04-23 11:50:11 -0700
committerTim Smith <tsmith84@gmail.com>2020-04-23 11:50:11 -0700
commit198adcec78affb0d6c820bf0449ac60b29f517d7 (patch)
tree4133440650216cd405914ab77e3eb79f6799c7c5
parent52589c1aa6106b54f938780d9e9e7965a7b165e9 (diff)
downloadchef-198adcec78affb0d6c820bf0449ac60b29f517d7.tar.gz
Minor improvements to the resource descriptions
Update things so we spit out better docs. Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/rpm_package.rb2
-rw-r--r--lib/chef/resource/script.rb3
-rw-r--r--lib/chef/resource/service.rb2
-rw-r--r--lib/chef/resource/windows_firewall_rule.rb1
4 files changed, 5 insertions, 3 deletions
diff --git a/lib/chef/resource/rpm_package.rb b/lib/chef/resource/rpm_package.rb
index 76887a079e..b944142dcb 100644
--- a/lib/chef/resource/rpm_package.rb
+++ b/lib/chef/resource/rpm_package.rb
@@ -25,7 +25,7 @@ class Chef
provides :rpm_package
- description "Use the rpm_package resource to manage packages for the RPM Package Manager platform."
+ description "Use the rpm_package resource to manage packages using the RPM Package Manager."
property :allow_downgrade, [ true, false ], default: true, desired_state: false
diff --git a/lib/chef/resource/script.rb b/lib/chef/resource/script.rb
index 88a5621c9f..71c2f754e4 100644
--- a/lib/chef/resource/script.rb
+++ b/lib/chef/resource/script.rb
@@ -49,8 +49,9 @@ class Chef
property :code, String, required: true
property :interpreter, String
- property :flags, String
+ property :flags, String,
+ description: "One or more command line flags that are passed to the interpreter when a command is invoked."
end
end
end
diff --git a/lib/chef/resource/service.rb b/lib/chef/resource/service.rb
index 25cc84b163..50a7dda437 100644
--- a/lib/chef/resource/service.rb
+++ b/lib/chef/resource/service.rb
@@ -82,7 +82,7 @@ class Chef
# specify overrides for the start_command, stop_command and
# restart_command properties.
property :init_command, String,
- description: "The path to the init script that is associated with the service. Use init_command to prevent the need to specify overrides for the start_command, stop_command, and restart_command properties. When this property is not specified, the #{Chef::Dist::CLIENT} will use the default init command for the service provider being used.",
+ description: "The path to the init script that is associated with the service. Use init_command to prevent the need to specify overrides for the start_command, stop_command, and restart_command properties. When this property is not specified, the #{Chef::Dist::PRODUCT} will use the default init command for the service provider being used.",
desired_state: false
# if the service is enabled or not
diff --git a/lib/chef/resource/windows_firewall_rule.rb b/lib/chef/resource/windows_firewall_rule.rb
index 7bb69a271f..fcba0dc569 100644
--- a/lib/chef/resource/windows_firewall_rule.rb
+++ b/lib/chef/resource/windows_firewall_rule.rb
@@ -78,6 +78,7 @@ class Chef
property :displayname, String,
description: "The displayname to assign to the firewall rule.",
default: lazy { rule_name },
+ default_description: "The rule_name property value.",
introduced: "16.0"
property :group, String,