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/ruby.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/ruby.rb')
-rw-r--r-- | lib/chef/resource/ruby.rb | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/chef/resource/ruby.rb b/lib/chef/resource/ruby.rb index 91805a1db6..300405f89e 100644 --- a/lib/chef/resource/ruby.rb +++ b/lib/chef/resource/ruby.rb @@ -21,6 +21,10 @@ require "chef/provider/script" class Chef class Resource + # Use the ruby resource to execute scripts using the Ruby interpreter. 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 Ruby < Chef::Resource::Script def initialize(name, run_context = nil) super |