diff options
author | Tim Smith <tsmith@chef.io> | 2017-12-13 12:14:25 -0800 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2017-12-13 12:14:25 -0800 |
commit | be8540a076226051029dc161895bc887eb4813b1 (patch) | |
tree | 28fe954cddc386a188ffb2ed2dbbc6a1510500c4 /lib/chef/run_context.rb | |
parent | 0d14959ebef1f7cd051e1621e9785555981d5500 (diff) | |
download | chef-be8540a076226051029dc161895bc887eb4813b1.tar.gz |
Cleanup some YARD warningsyard2
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/run_context.rb')
-rw-r--r-- | lib/chef/run_context.rb | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/chef/run_context.rb b/lib/chef/run_context.rb index fc32ab3eeb..b2eee0406e 100644 --- a/lib/chef/run_context.rb +++ b/lib/chef/run_context.rb @@ -29,7 +29,6 @@ require "forwardable" class Chef - # == Chef::RunContext # Value object that loads and tracks the context of a Chef run class RunContext # @@ -312,7 +311,7 @@ class Chef # # @param recipe_names [Array[String]] The recipe name (e.g 'my_cookbook' or # 'my_cookbook::my_resource'). - # @param current_cookbook The cookbook we are currently running in. + # @param current_cookbook [String] The cookbook we are currently running in. # # @return A truthy value if the load occurred; `false` if already loaded. # @@ -556,11 +555,18 @@ ERROR_MESSAGE @reboot_info = reboot_info end + # + # Cancels a pending reboot + # def cancel_reboot Chef::Log.info "Changing reboot status from #{reboot_info.inspect} to {}" @reboot_info = {} end + # + # Checks to see if a reboot has been requested + # @return [Boolean] + # def reboot_requested? reboot_info.size > 0 end |