Tweak the doc for Rails/DynamicFindBy

koic · koic · commit 313cd20c898c · 2022-09-26T10:58:40.000+09:00
diff --git a/lib/rubocop/cop/rails/dynamic_find_by.rb b/lib/rubocop/cop/rails/dynamic_find_by.rb
@@ -22,14 +22,14 @@ module Rails
       #   User.find_by(name: name, email: email)
       #   User.find_by!(email: email)
       #
-      # @example AllowedMethods: find_by_sql
+      # @example AllowedMethods: ['find_by_sql'] (default)
       #   # bad
       #   User.find_by_query(users_query)
       #
       #   # good
       #   User.find_by_sql(users_sql)
       #
-      # @example AllowedReceivers: Gem::Specification
+      # @example AllowedReceivers: ['Gem::Specification'] (default)
       #   # bad
       #   Specification.find_by_name('backend').gem_dir
       #

Original file line number	Diff line number	Diff line change
`@@ -22,14 +22,14 @@ module Rails`
`22`	`22`	`# User.find_by(name: name, email: email)`
`23`	`23`	`# User.find_by!(email: email)`
`24`	`24`	`#`
`25`		`- # @example AllowedMethods: find_by_sql`
	`25`	`+ # @example AllowedMethods: ['find_by_sql'] (default)`
`26`	`26`	`# # bad`
`27`	`27`	`# User.find_by_query(users_query)`
`28`	`28`	`#`
`29`	`29`	`# # good`
`30`	`30`	`# User.find_by_sql(users_sql)`
`31`	`31`	`#`
`32`		`- # @example AllowedReceivers: Gem::Specification`
	`32`	`+ # @example AllowedReceivers: ['Gem::Specification'] (default)`
`33`	`33`	`# # bad`
`34`	`34`	`# Specification.find_by_name('backend').gem_dir`
`35`	`35`	`#`