diff options
| author | Tim Smith <tsmith@chef.io> | 2017-12-19 13:40:22 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-19 13:40:22 -0800 |
| commit | 0ebf198dd0a8788fcc536ea31e4b01a89fa63522 (patch) | |
| tree | dc1579a4d86882ab3e766186a808d8acbeab5d12 /lib/chef/resource/log.rb | |
| parent | 04d5cdb9bac717d9682707d0ffc65aaf3a7c591e (diff) | |
| parent | 034f00f6c466c3924e5fdb069b484d1961283c76 (diff) | |
| download | chef-0ebf198dd0a8788fcc536ea31e4b01a89fa63522.tar.gz | |
Merge pull request #6696 from chef/yard
Add descriptions and yard @since comments to all resources
Diffstat (limited to 'lib/chef/resource/log.rb')
| -rw-r--r-- | lib/chef/resource/log.rb | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/chef/resource/log.rb b/lib/chef/resource/log.rb index 32d9629b73..b6da123526 100644 --- a/lib/chef/resource/log.rb +++ b/lib/chef/resource/log.rb @@ -21,7 +21,10 @@ require "chef/resource" class Chef class Resource - # Sends a string to a log provider. + # Use the log resource to create log entries. The log resource behaves like any other resource: built into the resource + # collection during the compile phase, and then run during the execution phase. (To create a log entry that is not built + # into the resource collection, use Chef::Log instead of the log resource.) + # # Allows logging a :debug, :info, :warn, and :error levels # Defaults to :info level # |