diff options
| author | Tim Smith <tsmith@chef.io> | 2017-12-19 11:22:19 -0800 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2017-12-19 11:22:19 -0800 |
| commit | 034f00f6c466c3924e5fdb069b484d1961283c76 (patch) | |
| tree | e2f6d9b911c838df661d1bd9cd643858a19847b9 /lib/chef/resource/dsc_script.rb | |
| parent | fc813e21f253d5278cb42710874a34cfebfcc8ca (diff) | |
| download | chef-034f00f6c466c3924e5fdb069b484d1961283c76.tar.gz | |
Add descriptions and @since comments to all resources
From the docs site
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/resource/dsc_script.rb')
| -rw-r--r-- | lib/chef/resource/dsc_script.rb | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/lib/chef/resource/dsc_script.rb b/lib/chef/resource/dsc_script.rb index 7682c7e778..cea52e422b 100644 --- a/lib/chef/resource/dsc_script.rb +++ b/lib/chef/resource/dsc_script.rb @@ -21,6 +21,11 @@ require "chef/dsl/powershell" class Chef class Resource + # Many DSC resources are comparable to built-in Chef resources. For example, both DSC and Chef have file, package, + # and service resources. The dsc_script resource is most useful for those DSC resources that do not have a direct + # comparison to a resource in Chef, such as the Archive resource, a custom DSC resource, an existing DSC script + # that performs an important task, and so on. Use the dsc_script resource to embed the code that defines a DSC + # configuration directly within a Chef recipe. class DscScript < Chef::Resource include Chef::DSL::Powershell |