diff options
author | Lamont Granquist <lamont@scriptkiddie.org> | 2015-10-22 11:02:15 -0700 |
---|---|---|
committer | Lamont Granquist <lamont@scriptkiddie.org> | 2015-10-26 16:21:07 -0700 |
commit | 5a848713b2666f476a3d65b38933d2b8dfb55504 (patch) | |
tree | f037d8ae279098f50732868acec19ed26a059b59 /lib/chef | |
parent | b7c8e96112c298b5525b0dcb3aa2ff2143666d49 (diff) | |
download | chef-5a848713b2666f476a3d65b38933d2b8dfb55504.tar.gz |
add @raises doc for #validate!
Diffstat (limited to 'lib/chef')
-rw-r--r-- | lib/chef/cookbook/cookbook_collection.rb | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/chef/cookbook/cookbook_collection.rb b/lib/chef/cookbook/cookbook_collection.rb index af8bbd15b9..38784c22fa 100644 --- a/lib/chef/cookbook/cookbook_collection.rb +++ b/lib/chef/cookbook/cookbook_collection.rb @@ -45,6 +45,9 @@ class Chef # # Currently checks chef_version and ohai_version in the cookbook metadata # against the running Chef::VERSION and Ohai::VERSION. + # + # @raises [Chef::Exceptions::CookbookChefVersionMismatch] if the Chef::VERSION fails validation + # @raises [Chef::Exceptions::CookbookOhaiVersionMismatch] if the Ohai::VERSION fails validation def validate! each do |cookbook_name, cookbook_version| cookbook_version.metadata.validate_chef_version! |