Improve documentation for Style/EvalWithLocation cop

Add description and example code for the case that a string variable is given as a code string.
rubocop · Feb 14, 2021 · fcb3a94 · fcb3a94
1 parent 6cdce3b
commit fcb3a94
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/changelog/change_improve_documentation_for_style_eval_with_location_cop.md b/changelog/change_improve_documentation_for_style_eval_with_location_cop.md
@@ -0,0 +1 @@
+* [#9405](https://github.com/rubocop-hq/rubocop/pull/9405): Improve documentation for `Style/EvalWithLocation` cop. ([@taichi-ishitani][])
diff --git a/lib/rubocop/cop/style/eval_with_location.rb b/lib/rubocop/cop/style/eval_with_location.rb
@@ -41,6 +41,18 @@ module Style
       #     def do_something
       #     end
       #   RUBY
+      #
+      # This cop works only when a string literal is given as a code string.
+      # No offence is reported if a string variable is given as below:
+      #
+      # @example
+      #   # not checked
+      #   code = <<-RUBY
+      #     def do_something
+      #     end
+      #   RUBY
+      #   eval code
+      #
       class EvalWithLocation < Base
         extend AutoCorrector