Fix documentation example typos

Signed-off-by: Tim Smith <tsmith@chef.io>
chef · Feb 24, 2022 · 1c08723 · 1c08723
1 parent c01ecbc
commit 1c08723
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 6 deletions.
diff --git a/lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb b/lib/rubocop/cop/chef/correctness/invalid_platform_helper.rb
@@ -25,12 +25,12 @@ module Correctness
         #
         #   #### incorrect
         #   platform?('darwin')
-        #   platform?('rhel)
+        #   platform?('rhel')
         #   platform?('sles')
         #
         #   #### correct
         #   platform?('mac_os_x')
-        #   platform?('redhat)
+        #   platform?('redhat')
         #   platform?('suse')
         #
         class InvalidPlatformHelper < Base

diff --git a/lib/rubocop/cop/chef/deprecation/chefdk_generators.rb b/lib/rubocop/cop/chef/deprecation/chefdk_generators.rb
@@ -27,14 +27,14 @@ module Deprecations
         #   ChefDK::CLI
         #   ChefDK::Generator::TemplateHelper
         #   module ChefDK
-        #     ...
+        #     # some additional code
         #   end
         #
         #   #### correct
         #   ChefCLI::CLI
         #   ChefCLI::Generator::TemplateHelper
         #   module ChefCLI
-        #     ...
+        #     # some additional code
         #   end
         #
         class ChefDKGenerators < Base

diff --git a/lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb b/lib/rubocop/cop/chef/deprecation/resource_uses_updated_method.rb
@@ -30,7 +30,7 @@ module Deprecations
         #
         #   #### correct
         #   action :foo do
-        #     converge_by('resource did something) do
+        #     converge_by('resource did something') do
         #       # code that causes the resource to converge
         #     end
         #

diff --git a/lib/rubocop/cop/chef/deprecation/use_automatic_resource_name.rb b/lib/rubocop/cop/chef/deprecation/use_automatic_resource_name.rb
@@ -28,7 +28,8 @@ module Deprecations
         #     class MyCookbookService < Chef::Resource
         #       use_automatic_resource_name
         #       provides :mycookbook_service
-        #       ...
+        #       
+        #       # some additional code
         #     end
         #   end
         #

diff --git a/lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb b/lib/rubocop/cop/chef/style/simplify_platform_major_version_check.rb
@@ -33,6 +33,8 @@ module Style
         #
         #   # check to see if we're on RHEL 7 on a RHEL 7.6 node where node['platform_version] is 7.6.1810
         #   if node['platform_version'].to_i == 7
+        #     # some code
+        #   end
         #
         class SimplifyPlatformMajorVersionCheck < Base
           extend AutoCorrector