diff options
| author | Lamont Granquist <lamont@scriptkiddie.org> | 2015-02-05 12:59:36 -0800 |
|---|---|---|
| committer | Lamont Granquist <lamont@scriptkiddie.org> | 2015-02-05 12:59:36 -0800 |
| commit | 9923b30d0f3d43f8ee926d882254a7dfe2b7570d (patch) | |
| tree | 79fb527e2dfc29b709e9811cb2b7a3f6c5f5c221 | |
| parent | 062227a7139f8109e1ebc9a8de4efe770ff32673 (diff) | |
| download | chef-9923b30d0f3d43f8ee926d882254a7dfe2b7570d.tar.gz | |
update docs
| -rw-r--r-- | lib/chef/resource.rb | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/lib/chef/resource.rb b/lib/chef/resource.rb index a767dbe2d6..a90232fdb7 100644 --- a/lib/chef/resource.rb +++ b/lib/chef/resource.rb @@ -133,6 +133,12 @@ class Chef # # This is also used in to_s to show the resource name, e.g. `execute[Vitruvius]`. # + # This is also used for resource notifications and subscribes in the same manner. + # + # This will coerce any object into a string via #to_s. Arrays are a special case + # so that `package ["foo", "bar"]` becomes package[foo, bar] instead of the more + # awkward `package[["foo", "bar"]]` that #to_s would produce. + # # @param name [String] The name to set. # @return [String] The name of this Resource. # |