summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy Allan <github@gravitystorm.co.uk>2021-12-29 11:54:01 +0000
committerGitHub <noreply@github.com>2021-12-29 11:54:01 +0000
commitbb2d8ecd43e1d424204afc527311c3f6adbdfba3 (patch)
treead14a6880cc026a03f68234a015cfda5e111290c
parent50a0001bae754c66feb69c84b64cb305a03a34d2 (diff)
downloadchef-bb2d8ecd43e1d424204afc527311c3f6adbdfba3.tar.gz
Fix typo in subscribes method documentation
In the direct resource example, the intention is to show that you can subscribe to the resource using a reference to the resource, instead of a string. The subscribes line should therefore reference `bar`. This is similar to the multiple string vs direct resource examples that follow just below. Obvious fix.
-rw-r--r--lib/chef/resource.rb2
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/chef/resource.rb b/lib/chef/resource.rb
index 746efb5fd4..03444ce38c 100644
--- a/lib/chef/resource.rb
+++ b/lib/chef/resource.rb
@@ -311,7 +311,7 @@ class Chef
# file '/foo.txt' do
# content 'hi'
# action :nothing
- # subscribes :create, '/bar.txt'
+ # subscribes :create, bar
# end
# @example Multiple resources by string
# file '/foo.txt' do