Fix some yard warningsyard_warnings

More Rubymine warnings

Signed-off-by: Tim Smith <tsmith@chef.io>

9 files changed, 11 insertions, 13 deletions

diff --git a/lib/chef/api_client.rb b/lib/chef/api_client.rb
index 551d9a6035..656a0e364f 100644
--- a/lib/chef/api_client.rb
+++ b/lib/chef/api_client.rb
@@ -83,7 +83,7 @@ class Chef
 
     # Gets or sets whether this client is a validator.
     #
-    # @param [Boolean] whether or not the client is a validator.  If
+    # @param [Boolean] arg whether or not the client is a validator.  If
     #   `nil`, retrieves the already-set value.
     # @return [Boolean] The current value
     def validator(arg = nil)
diff --git a/lib/chef/chef_fs/data_handler/policy_data_handler.rb b/lib/chef/chef_fs/data_handler/policy_data_handler.rb
index fa7bbe9101..91c59f2a0b 100644
--- a/lib/chef/chef_fs/data_handler/policy_data_handler.rb
+++ b/lib/chef/chef_fs/data_handler/policy_data_handler.rb
@@ -28,7 +28,7 @@ class Chef
 
         # Verify that the JSON hash for this type has a key that matches its name.
         #
-        # @param object [Object] JSON hash of the object
+        # @param object_data [Object] JSON hash of the object
         # @param entry [Chef::ChefFS::FileSystem::BaseFSObject] filesystem object we are verifying
         # @yield  [s] callback to handle errors
         # @yieldparam [s<string>] error message
diff --git a/lib/chef/chef_fs/data_handler/policy_group_data_handler.rb b/lib/chef/chef_fs/data_handler/policy_group_data_handler.rb
index f7aa92373c..397abdcc3e 100644
--- a/lib/chef/chef_fs/data_handler/policy_group_data_handler.rb
+++ b/lib/chef/chef_fs/data_handler/policy_group_data_handler.rb
@@ -17,7 +17,7 @@ class Chef
 
         # Verify that the JSON hash for this type has a key that matches its name.
         #
-        # @param object [Object] JSON hash of the object
+        # @param object_data [Object] JSON hash of the object
         # @param entry [Chef::ChefFS::FileSystem::BaseFSObject] filesystem object we are verifying
         # @yield  [s] callback to handle errors
         # @yieldparam [s<string>] error message
diff --git a/lib/chef/cookbook/chefignore.rb b/lib/chef/cookbook/chefignore.rb
index a27af68cb0..d905e027d6 100644
--- a/lib/chef/cookbook/chefignore.rb
+++ b/lib/chef/cookbook/chefignore.rb
@@ -33,7 +33,7 @@ class Chef
         @ignores = parse_ignore_file
       end
 
-      # @param [Array] list the list of cookbook files
+      # @param [Array] file_list the list of cookbook files
       # @return [Array] list of cookbook files with chefignore files removed
       def remove_ignores_from(file_list)
         Array(file_list).inject([]) do |unignored, file|
diff --git a/lib/chef/data_collector/messages/helpers.rb b/lib/chef/data_collector/messages/helpers.rb
index d9a3394265..e451db2c63 100644
--- a/lib/chef/data_collector/messages/helpers.rb
+++ b/lib/chef/data_collector/messages/helpers.rb
@@ -27,8 +27,6 @@ class Chef
         # If the chef_server_url cannot be parsed as a URI, the node["fqdn"] attribute
         # will be returned, or "localhost" if the run_status is unavailable to us.
         #
-        # @param run_status [Chef::RunStatus] The RunStatus object for this Chef Run.
-        #
         # @return [String] FQDN of the configured Chef Server, or node/localhost if not found.
         #
         def chef_server_fqdn
diff --git a/lib/chef/provider/apt_repository.rb b/lib/chef/provider/apt_repository.rb
index 6bbb052792..31dfc5c5d4 100644
--- a/lib/chef/provider/apt_repository.rb
+++ b/lib/chef/provider/apt_repository.rb
@@ -148,7 +148,7 @@ class Chef
       end
 
       # determine if a cookbook file is available in the run
-      # @param [String] path the path to the cookbook file
+      # @param [String] fn the path to the cookbook file
       #
       # @return [Boolean] cookbook file exists or doesn't
       def has_cookbook_file?(fn)
diff --git a/lib/chef/provider/zypper_repository.rb b/lib/chef/provider/zypper_repository.rb
index 31cf8839b2..e9d1f84272 100644
--- a/lib/chef/provider/zypper_repository.rb
+++ b/lib/chef/provider/zypper_repository.rb
@@ -89,7 +89,7 @@ class Chef
       end
 
       # determine if a cookbook file is available in the run
-      # @param [String] path the path to the template file
+      # @param [String] fn the path to the template file
       #
       # @return [Boolean] cookbook file exists or doesn't
       def has_cookbook_file?(fn)
diff --git a/lib/chef/resource/resource_notification.rb b/lib/chef/resource/resource_notification.rb
index 6ede2fc346..24f8821b6b 100644
--- a/lib/chef/resource/resource_notification.rb
+++ b/lib/chef/resource/resource_notification.rb
@@ -36,7 +36,7 @@ class Chef
 
       # Is the current notification a duplicate of another notification
       #
-      # @param [Notification] another notification object to compare to
+      # @param [Notification] other_notification another notification object to compare to
       # @return [Boolean] does the resource match
       def duplicates?(other_notification)
         unless other_notification.respond_to?(:resource) && other_notification.respond_to?(:action)
diff --git a/lib/chef/run_context.rb b/lib/chef/run_context.rb
index b2eee0406e..a3dd6cffba 100644
--- a/lib/chef/run_context.rb
+++ b/lib/chef/run_context.rb
@@ -206,7 +206,7 @@ class Chef
     #
     # Adds an before notification to the +before_notification_collection+.
     #
-    # @param [Chef::Resource::Notification] The notification to add.
+    # @param [Chef::Resource::Notification] notification The notification to add.
     #
     def notifies_before(notification)
       # Note for the future, notification.notifying_resource may be an instance
@@ -218,7 +218,7 @@ class Chef
     #
     # Adds an immediate notification to the +immediate_notification_collection+.
     #
-    # @param [Chef::Resource::Notification] The notification to add.
+    # @param [Chef::Resource::Notification] notification The notification to add.
     #
     def notifies_immediately(notification)
       # Note for the future, notification.notifying_resource may be an instance
@@ -230,7 +230,7 @@ class Chef
     #
     # Adds a delayed notification to the +delayed_notification_collection+.
     #
-    # @param [Chef::Resource::Notification] The notification to add.
+    # @param [Chef::Resource::Notification] notification The notification to add.
     #
     def notifies_delayed(notification)
       # Note for the future, notification.notifying_resource may be an instance
@@ -309,7 +309,7 @@ class Chef
     #      I don't see anything different beyond accepting and returning an
     #      array of recipes.
     #
-    # @param recipe_names [Array[String]] The recipe name (e.g 'my_cookbook' or
+    # @param recipe_name [Array[String]] The recipe name (e.g 'my_cookbook' or
     #   'my_cookbook::my_resource').
     # @param current_cookbook [String] The cookbook we are currently running in.
     #