Merge pull request #1302 from ydah/add_document_for_expect_actual

bquorning · web-flow · commit d028400c1946 · 2022-06-30T22:52:23.000+01:00
Improved documentation for `RSpec/ExpectActual`
diff --git a/docs/modules/ROOT/pages/cops_rspec.adoc b/docs/modules/ROOT/pages/cops_rspec.adoc
@@ -1483,6 +1483,8 @@ end
 
 Checks for `expect(...)` calls containing literal values.
 
+Autocorrection is performed when the expected is not a literal.
+
 === Examples
 
 [source,ruby]
diff --git a/lib/rubocop/cop/rspec/expect_actual.rb b/lib/rubocop/cop/rspec/expect_actual.rb
@@ -5,6 +5,8 @@ module Cop
     module RSpec
       # Checks for `expect(...)` calls containing literal values.
       #
+      # Autocorrection is performed when the expected is not a literal.
+      #
       # @example
       #   # bad
       #   expect(5).to eq(price)

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@ module Cop`
`5`	`5`	`module RSpec`
`6`	`6`	# Checks for `expect(...)` calls containing literal values.
`7`	`7`	`#`
	`8`	`+ # Autocorrection is performed when the expected is not a literal.`
	`9`	`+ #`
`8`	`10`	`# @example`
`9`	`11`	`# # bad`
`10`	`12`	`# expect(5).to eq(price)`