diff options
| author | Tim Smith <tsmith@chef.io> | 2018-01-22 16:09:48 -0800 |
|---|---|---|
| committer | Tim Smith <tsmith@chef.io> | 2018-01-22 16:09:48 -0800 |
| commit | 98a89f1548de156d8995d8240a672df3d6e0f0dd (patch) | |
| tree | 2dc456918db3f110a16079ef448c4fd4afe80d08 /lib/chef/handler.rb | |
| parent | 9eb78fa2d0edb9366fc2bc34f9ec3954fda48261 (diff) | |
| download | chef-98a89f1548de156d8995d8240a672df3d6e0f0dd.tar.gz | |
Cleanup a bit of YARD and add a few things
Mostly remove some warnings when running yard on the CLI
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/handler.rb')
| -rw-r--r-- | lib/chef/handler.rb | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/lib/chef/handler.rb b/lib/chef/handler.rb index 100ed23d9e..34db223d43 100644 --- a/lib/chef/handler.rb +++ b/lib/chef/handler.rb @@ -19,14 +19,12 @@ require "chef/client" require "forwardable" class Chef - # == Chef::Handler # The base class for an Exception or Notification Handler. Create your own # handler by subclassing Chef::Handler. When a Chef run fails with an # uncaught Exception, Chef will set the +run_status+ on your handler and call # +report+ # - # ===Example: - # + # @example # require 'net/smtp' # # module MyOrg |