Merge pull request #8943 from koic/update_doc_for_flip_flop

Update doc for `Lint/FlipFlop`
rubocop · Oct 27, 2020 · 51cda39 · 51cda39
2 parents fd65a6b + d5b2229
commit 51cda39
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/docs/modules/ROOT/pages/cops_lint.adoc b/docs/modules/ROOT/pages/cops_lint.adoc
@@ -1565,8 +1565,14 @@ end
 | -
 |===
 
-This cop looks for uses of flip-flop operator.
-flip-flop operator is deprecated since Ruby 2.6.0.
+This cop looks for uses of flip-flop operator
+based on the Ruby Style Guide.
+
+Here is the history of flip-flops in Ruby.
+flip-flop operator is deprecated in Ruby 2.6.0 and
+the deprecation has been reverted by Ruby 2.7.0 and
+backported to Ruby 2.6.
+See: https://bugs.ruby-lang.org/issues/5400
 
 === Examples
 

diff --git a/lib/rubocop/cop/lint/flip_flop.rb b/lib/rubocop/cop/lint/flip_flop.rb
@@ -3,8 +3,14 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop looks for uses of flip-flop operator.
-      # flip-flop operator is deprecated since Ruby 2.6.0.
+      # This cop looks for uses of flip-flop operator
+      # based on the Ruby Style Guide.
+      #
+      # Here is the history of flip-flops in Ruby.
+      # flip-flop operator is deprecated in Ruby 2.6.0 and
+      # the deprecation has been reverted by Ruby 2.7.0 and
+      # backported to Ruby 2.6.
+      # See: https://bugs.ruby-lang.org/issues/5400
       #
       # @example
       #   # bad