summaryrefslogtreecommitdiff
path: root/lib/chef/chef_class.rb
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2017-12-13 12:14:25 -0800
committerTim Smith <tsmith@chef.io>2017-12-13 12:14:25 -0800
commitbe8540a076226051029dc161895bc887eb4813b1 (patch)
tree28fe954cddc386a188ffb2ed2dbbc6a1510500c4 /lib/chef/chef_class.rb
parent0d14959ebef1f7cd051e1621e9785555981d5500 (diff)
downloadchef-be8540a076226051029dc161895bc887eb4813b1.tar.gz
Cleanup some YARD warningsyard2
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/chef_class.rb')
-rw-r--r--lib/chef/chef_class.rb4
1 files changed, 2 insertions, 2 deletions
diff --git a/lib/chef/chef_class.rb b/lib/chef/chef_class.rb
index e61fd5e1d2..bfea51609a 100644
--- a/lib/chef/chef_class.rb
+++ b/lib/chef/chef_class.rb
@@ -200,8 +200,8 @@ class Chef
#
# Emit a deprecation message.
#
- # @param type The message to send. This should be a symbol, referring to
- # a class defined in Chef::Deprecated
+ # @param [Symbol] type The message to send. This should refer to a class
+ # defined in Chef::Deprecated
# @param message An explicit message to display, rather than the generic one
# associated with the deprecation.
# @param location The location. Defaults to the caller who called you (since