Skip to content

Commit 2b228a8

Browse files
koickoic
authored
Merge pull request #1551 from r7kamura/docs-required-typo
Improve docs about Rails version notes
2 parents 48710fa + c6b201f commit 2b228a8

File tree

2 files changed

+26
-26
lines changed

2 files changed

+26
-26
lines changed

‎docs/modules/ROOT/pages/cops_rails.adoc‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ end
5353
[#railsactioncontrollertestcase]
5454
== Rails/ActionControllerTestCase
5555
56-
NOTE: Required Rails version: 5.0
56+
NOTE: Requires Rails version 5.0
5757
5858
|===
5959
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -580,7 +580,7 @@ end
580580
[#railsapplicationjob]
581581
== Rails/ApplicationJob
582582
583-
NOTE: Required Rails version: 5.0
583+
NOTE: Requires Rails version 5.0
584584
585585
|===
586586
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -619,7 +619,7 @@ end
619619
[#railsapplicationmailer]
620620
== Rails/ApplicationMailer
621621
622-
NOTE: Required Rails version: 5.0
622+
NOTE: Requires Rails version 5.0
623623
624624
|===
625625
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -658,7 +658,7 @@ end
658658
[#railsapplicationrecord]
659659
== Rails/ApplicationRecord
660660
661-
NOTE: Required Rails version: 5.0
661+
NOTE: Requires Rails version 5.0
662662
663663
|===
664664
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -877,7 +877,7 @@ end
877877
[#railsbelongsto]
878878
== Rails/BelongsTo
879879
880-
NOTE: Required Rails version: 5.0
880+
NOTE: Requires Rails version 5.0
881881
882882
|===
883883
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -1158,7 +1158,7 @@ end
11581158
[#railscompactblank]
11591159
== Rails/CompactBlank
11601160
1161-
NOTE: Required Rails version: 6.1
1161+
NOTE: Requires Rails version 6.1
11621162
11631163
|===
11641164
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -1216,7 +1216,7 @@ collection.compact_blank!
12161216
[#railscontenttag]
12171217
== Rails/ContentTag
12181218
1219-
NOTE: Required Rails version: 5.1
1219+
NOTE: Requires Rails version 5.1
12201220
12211221
|===
12221222
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -2084,7 +2084,7 @@ enum status: { active: 0, archived: 1 }
20842084
20852085
NOTE: Requires Ruby version 3.0
20862086
2087-
NOTE: Required Rails version: 7.0
2087+
NOTE: Requires Rails version 7.0
20882088
20892089
|===
20902090
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -2187,7 +2187,7 @@ enum status: [:active, :archived]
21872187
[#railsenvlocal]
21882188
== Rails/EnvLocal
21892189
2190-
NOTE: Required Rails version: 7.1
2190+
NOTE: Requires Rails version 7.1
21912191
21922192
|===
21932193
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -2395,7 +2395,7 @@ raise 'a bad error has happened'
23952395
[#railsexpandeddaterange]
23962396
== Rails/ExpandedDateRange
23972397
2398-
NOTE: Required Rails version: 5.1
2398+
NOTE: Requires Rails version 5.1
23992399
24002400
|===
24012401
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -2746,7 +2746,7 @@ User.order(:foo).each
27462746
[#railsfreezetime]
27472747
== Rails/FreezeTime
27482748
2749-
NOTE: Required Rails version: 5.2
2749+
NOTE: Requires Rails version 5.2
27502750
27512751
|===
27522752
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -2959,7 +2959,7 @@ end
29592959
[#railshttppositionalarguments]
29602960
== Rails/HttpPositionalArguments
29612961
2962-
NOTE: Required Rails version: 5.0
2962+
NOTE: Requires Rails version 5.0
29632963
29642964
|===
29652965
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -3465,7 +3465,7 @@ Hash[[1, 2, 3].collect { |el| [foo(el), el] }]
34653465
[#railsindexwith]
34663466
== Rails/IndexWith
34673467
3468-
NOTE: Required Rails version: 6.0
3468+
NOTE: Requires Rails version 6.0
34693469
34703470
|===
34713471
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -4415,7 +4415,7 @@ safe_join([user_content, " ", content_tag(:span, user_content)])
44154415
[#railspick]
44164416
== Rails/Pick
44174417
4418-
NOTE: Required Rails version: 6.0
4418+
NOTE: Requires Rails version 6.0
44194419
44204420
|===
44214421
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -4468,7 +4468,7 @@ Model.pick(:a)
44684468
[#railspluck]
44694469
== Rails/Pluck
44704470
4471-
NOTE: Required Rails version: 5.0
4471+
NOTE: Requires Rails version 5.0
44724472
44734473
|===
44744474
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -5145,7 +5145,7 @@ end
51455145
[#railsredundantpresencevalidationonbelongsto]
51465146
== Rails/RedundantPresenceValidationOnBelongsTo
51475147
5148-
NOTE: Required Rails version: 5.0
5148+
NOTE: Requires Rails version 5.0
51495149
51505150
|===
51515151
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -5267,7 +5267,7 @@ end
52675267
[#railsredundanttravelback]
52685268
== Rails/RedundantTravelBack
52695269
5270-
NOTE: Required Rails version: 5.2
5270+
NOTE: Requires Rails version 5.2
52715271
52725272
|===
52735273
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -5635,7 +5635,7 @@ request.referrer
56355635
[#railsrequiredependency]
56365636
== Rails/RequireDependency
56375637
5638-
NOTE: Required Rails version: 6.0
5638+
NOTE: Requires Rails version 6.0
56395639
56405640
|===
56415641
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -5675,7 +5675,7 @@ require_dependency 'some_lib'
56755675
[#railsresponseparsedbody]
56765676
== Rails/ResponseParsedBody
56775677
5678-
NOTE: Required Rails version: 5.0
5678+
NOTE: Requires Rails version 5.0
56795679
56805680
|===
56815681
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -6770,7 +6770,7 @@ EOS
67706770
[#railsstrongparametersexpect]
67716771
== Rails/StrongParametersExpect
67726772
6773-
NOTE: Required Rails version: 8.0
6773+
NOTE: Requires Rails version 8.0
67746774
67756775
|===
67766776
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -7068,7 +7068,7 @@ end
70687068
[#railstoformatteds]
70697069
== Rails/ToFormattedS
70707070
7071-
NOTE: Required Rails version: 7.0
7071+
NOTE: Requires Rails version 7.0
70727072
70737073
|===
70747074
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -7129,7 +7129,7 @@ time.to_formatted_s(:db)
71297129
[#railstoswithargument]
71307130
== Rails/ToSWithArgument
71317131
7132-
NOTE: Required Rails version: 7.0
7132+
NOTE: Requires Rails version 7.0
71337133
71347134
|===
71357135
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -7164,7 +7164,7 @@ obj.to_formatted_s(:delimited)
71647164
[#railstoplevelhashwithindifferentaccess]
71657165
== Rails/TopLevelHashWithIndifferentAccess
71667166
7167-
NOTE: Required Rails version: 5.1
7167+
NOTE: Requires Rails version 5.1
71687168
71697169
|===
71707170
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -7774,7 +7774,7 @@ User.where('length(name) > 10').exists?
77747774
[#railswheremissing]
77757775
== Rails/WhereMissing
77767776
7777-
NOTE: Required Rails version: 6.1
7777+
NOTE: Requires Rails version 6.1
77787778
77797779
|===
77807780
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
@@ -7909,7 +7909,7 @@ User.where.not('trashed = ? OR role = ?', true, 'admin')
79097909
79107910
NOTE: Requires Ruby version 2.6
79117911
7912-
NOTE: Required Rails version: 6.0
7912+
NOTE: Requires Rails version 6.0
79137913
79147914
|===
79157915
| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed

‎tasks/cops_documentation.rake‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ task update_cops_documentation: :yard_for_generate_documentation do
1616
required_rails_version = lambda do |data|
1717
return '' unless (version = data.cop.gem_requirements[RuboCop::Cop::TargetRailsVersion::TARGET_GEM_NAME])
1818

19-
"NOTE: Required Rails version: #{version.requirements[0][1]}\n\n"
19+
"NOTE: Requires Rails version #{version.requirements[0][1]}\n\n"
2020
end
2121
extra_info = { required_ruby_version: required_rails_version }
2222

0 commit comments

Comments
 (0)