diff options
| author | Tim Smith <tsmith@chef.io> | 2020-04-23 14:05:57 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-23 14:05:57 -0700 |
| commit | 2030ccda7e84394613e74ada8b7e36f853e72f35 (patch) | |
| tree | 22b1d715baf02fcd7ed47c70915f7c21e6a19cd5 | |
| parent | 52589c1aa6106b54f938780d9e9e7965a7b165e9 (diff) | |
| parent | fe1c5b5a07ba1c95320a322d61387ab75f417604 (diff) | |
| download | chef-2030ccda7e84394613e74ada8b7e36f853e72f35.tar.gz | |
Merge pull request #9725 from chef/docs_improvements
Minor improvements to the resource descriptions
| -rw-r--r-- | lib/chef/resource/rpm_package.rb | 2 | ||||
| -rw-r--r-- | lib/chef/resource/script.rb | 7 | ||||
| -rw-r--r-- | lib/chef/resource/service.rb | 2 | ||||
| -rw-r--r-- | lib/chef/resource/windows_firewall_rule.rb | 1 |
4 files changed, 8 insertions, 4 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..f7e1a013ef 100644 --- a/lib/chef/resource/script.rb +++ b/lib/chef/resource/script.rb @@ -47,10 +47,13 @@ class Chef end end - property :code, String, required: true + property :code, String, required: true, + description: "A quoted string of code to be executed." + 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, |