[Docs] Improve example of Lint/ToJSON (#8605)

rubocop · Sep 15, 2020 · 0d3f5e2 · 0d3f5e2
1 parent 3282218
commit 0d3f5e2
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 10 deletions.
diff --git a/docs/modules/ROOT/pages/cops_lint.adoc b/docs/modules/ROOT/pages/cops_lint.adoc
@@ -3833,12 +3833,23 @@ for an optional argument, your method should too.
 
 [source,ruby]
 ----
-# bad
-def to_json
-end
+class Point
+  attr_reader :x, :y
 
-# good
-def to_json(*_args)
+  # bad, incorrect arity
+  def to_json
+    JSON.generate([x, y])
+  end
+
+  # good, preserving args
+  def to_json(*args)
+    JSON.generate([x, y], *args)
+  end
+
+  # good, discarding args
+  def to_json(*_args)
+    JSON.generate([x, y])
+  end
 end
 ----
 

diff --git a/lib/rubocop/cop/lint/to_json.rb b/lib/rubocop/cop/lint/to_json.rb
@@ -9,12 +9,23 @@ module Lint
       # for an optional argument, your method should too.
       #
       # @example
-      #   # bad
-      #   def to_json
-      #   end
+      #   class Point
+      #     attr_reader :x, :y
+      #
+      #     # bad, incorrect arity
+      #     def to_json
+      #       JSON.generate([x, y])
+      #     end
+      #
+      #     # good, preserving args
+      #     def to_json(*args)
+      #       JSON.generate([x, y], *args)
+      #     end
       #
-      #   # good
-      #   def to_json(*_args)
+      #     # good, discarding args
+      #     def to_json(*_args)
+      #       JSON.generate([x, y])
+      #     end
       #   end
       #
       class ToJSON < Base