summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith84@gmail.com>2021-09-14 15:56:35 -0700
committerTim Smith <tsmith84@gmail.com>2021-09-14 15:56:35 -0700
commit02e653ebc3850615c819388b38d2e533097a52bd (patch)
treee20707d663bc8c4485dc1b9a04c91c0595980672
parentb82200afbddd5fa957d06ff6a2c659b6d41d6a9e (diff)
downloadchef-02e653ebc3850615c819388b38d2e533097a52bd.tar.gz
Fix descriptions in resources
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r--lib/chef/resource/chef_client_scheduled_task.rb2
-rw-r--r--lib/chef/resource/chocolatey_config.rb26
2 files changed, 14 insertions, 14 deletions
diff --git a/lib/chef/resource/chef_client_scheduled_task.rb b/lib/chef/resource/chef_client_scheduled_task.rb
index 8282e5fd4c..31ceb82238 100644
--- a/lib/chef/resource/chef_client_scheduled_task.rb
+++ b/lib/chef/resource/chef_client_scheduled_task.rb
@@ -66,7 +66,6 @@ class Chef
use_consistent_splay true
end
```
-
DOC
resource_name :chef_client_scheduled_task
@@ -145,6 +144,7 @@ class Chef
property :priority, Integer,
description: "Use to set Priority Levels range from 0 to 10.",
+ introduced: "17.5",
default: 7, callbacks: { "should be in range of 0 to 10" => proc { |v| v >= 0 && v <= 10 } }
action :add, description: "Add a Windows Scheduled Task that runs #{ChefUtils::Dist::Infra::PRODUCT}." do
diff --git a/lib/chef/resource/chocolatey_config.rb b/lib/chef/resource/chocolatey_config.rb
index 637d250e9b..6114dbe18c 100644
--- a/lib/chef/resource/chocolatey_config.rb
+++ b/lib/chef/resource/chocolatey_config.rb
@@ -24,22 +24,22 @@ class Chef
description "Use the **chocolatey_config** resource to add or remove Chocolatey configuration keys."
introduced "14.3"
examples <<~DOC
- **Set the Chocolatey cacheLocation config**:
+ **Set the Chocolatey cacheLocation config**:
- ```ruby
- chocolatey_config 'Set cacheLocation config' do
- config_key 'cacheLocation'
- value 'C:\temp\choco'
- end
- ```
+ ```ruby
+ chocolatey_config 'Set cacheLocation config' do
+ config_key 'cacheLocation'
+ value 'C:\\temp\\choco'
+ end
+ ```
- **Unset a Chocolatey config**:
+ **Unset a Chocolatey config**:
- ```ruby
- chocolatey_config 'BogusConfig' do
- action :unset
- end
- ```
+ ```ruby
+ chocolatey_config 'BogusConfig' do
+ action :unset
+ end
+ ```
DOC
property :config_key, String, name_property: true,