summaryrefslogtreecommitdiff
path: root/lib/chef/chef_fs
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_fs
parent0d14959ebef1f7cd051e1621e9785555981d5500 (diff)
downloadchef-be8540a076226051029dc161895bc887eb4813b1.tar.gz
Cleanup some YARD warningsyard2
Signed-off-by: Tim Smith <tsmith@chef.io>
Diffstat (limited to 'lib/chef/chef_fs')
-rw-r--r--lib/chef/chef_fs/data_handler/data_handler_base.rb6
1 files changed, 2 insertions, 4 deletions
diff --git a/lib/chef/chef_fs/data_handler/data_handler_base.rb b/lib/chef/chef_fs/data_handler/data_handler_base.rb
index 3668f77dd5..4b4696ce5e 100644
--- a/lib/chef/chef_fs/data_handler/data_handler_base.rb
+++ b/lib/chef/chef_fs/data_handler/data_handler_base.rb
@@ -56,8 +56,7 @@ class Chef
# 2. Put the actual values in the order of the defaults
# 3. Move any other values to the end
#
- # == Example
- #
+ # @example
# normalize_hash({x: 100, c: 2, a: 1}, { a: 10, b: 20, c: 30})
# -> { a: 1, b: 20, c: 2, x: 100}
#
@@ -140,8 +139,7 @@ class Chef
# the keys specified in "keys"; anything else must be emitted by the
# caller.
#
- # == Example
- #
+ # @example
# to_ruby_keys({"name" => "foo", "environment" => "desert", "foo": "bar"}, [ "name", "environment" ])
# ->
# 'name "foo"