summaryrefslogtreecommitdiff
path: root/lib/chef/resource/script.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2017-12-19 11:22:19 -0800
committerTim Smith <tsmith@chef.io>2017-12-19 11:22:19 -0800
commit034f00f6c466c3924e5fdb069b484d1961283c76 (patch)
treee2f6d9b911c838df661d1bd9cd643858a19847b9 /lib/chef/resource/script.rb
parentfc813e21f253d5278cb42710874a34cfebfcc8ca (diff)
downloadchef-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/script.rb')
-rw-r--r--lib/chef/resource/script.rb4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/chef/resource/script.rb b/lib/chef/resource/script.rb
index 5039e2d8fe..a7191360ca 100644
--- a/lib/chef/resource/script.rb
+++ b/lib/chef/resource/script.rb
@@ -22,6 +22,10 @@ require "chef/provider/script"
class Chef
class Resource
+ # Use the script resource to execute scripts using a specified interpreter, such as Bash, csh, Perl, Python, or Ruby.
+ # This resource may also use any of the actions and properties that are available to the execute resource. Commands
+ # that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the
+ # environment in which they are run. Use not_if and only_if to guard this resource for idempotence.
class Script < Chef::Resource::Execute
identity_attr :name