summaryrefslogtreecommitdiff
path: root/lib/chef/provider.rb
diff options
context:
space:
mode:
authorJohn Keiser <john@johnkeiser.com>2015-06-04 15:38:17 -0700
committerJohn Keiser <john@johnkeiser.com>2015-06-23 14:42:28 -0700
commitebc1edac19b1a20163cd4d6eb82dc25f0feec002 (patch)
tree003e1f23d892a2c996c84cbcd6c08c10eaeb8afa /lib/chef/provider.rb
parenta73ce9bd098f0507563a6f3961f9be385afa860c (diff)
downloadchef-ebc1edac19b1a20163cd4d6eb82dc25f0feec002.tar.gz
Add comments and use def self.x instead of class<<self
Diffstat (limited to 'lib/chef/provider.rb')
-rw-r--r--lib/chef/provider.rb7
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/chef/provider.rb b/lib/chef/provider.rb
index f3bc67d12f..1d106acccb 100644
--- a/lib/chef/provider.rb
+++ b/lib/chef/provider.rb
@@ -185,13 +185,18 @@ class Chef
#
# Include attributes, public and protected methods from this Resource in
- # the provider. Will delegate to
+ # the provider.
+ #
+ # If this is set to true, delegate methods are included in the provider so
+ # that you can call (for example) `attrname` and it will call
+ # `new_resource.attrname`.
#
# The actual include does not happen until the first time the Provider
# is instantiated (so that we don't have to worry about load order issues).
#
# @param include_resource_dsl [Boolean] Whether to include resource DSL or
# not (defaults to `false`).
+ #
def self.include_resource_dsl(include_resource_dsl)
@include_resource_dsl = include_resource_dsl
end