Merge pull request rubocop#164 from dylnclrk/edit-rake-environment-copy

Copyedit Rails/RakeEnvironment cop documentation.

config/default.yml

@@ -334,7 +334,7 @@ Rails/Present:
   UnlessBlank: true
 
 Rails/RakeEnvironment:
-  Description: 'Set `:environment` task as a dependency to all rake task.'
+  Description: 'Include `:environment` as a dependency for all Rake tasks.'
   Enabled: true
   Safe: false
   VersionAdded: '2.4'

lib/rubocop/cop/rails/rake_environment.rb

@@ -3,16 +3,16 @@
 module RuboCop
   module Cop
     module Rails
-      # This cop checks rake task definition without `environment` dependency.
-      # `environment` dependency is important because it loads application code
-      # for the rake task. The rake task cannot use application code, such as
-      # models, without `environment` dependency.
+      # This cop checks for Rake tasks without the `:environment` task
+      # dependency. The `:environment` task loads application code for other
+      # Rake tasks. Without it, tasks cannot make use of application code like
+      # models.
       #
       # You can ignore the offense if the task satisfies at least one of the
       # following conditions:
       #
       # * The task does not need application code.
-      # * The task invokes :environment task.
+      # * The task invokes the `:environment` task.
       #
       # @example
       #   # bad
@@ -26,7 +26,7 @@ module Rails
       #   end
       #
       class RakeEnvironment < Cop
-        MSG = 'Set `:environment` task as a dependency to all rake task.'
+        MSG = 'Include `:environment` task as a dependency for all Rake tasks.'
 
         def_node_matcher :task_definition?, <<~PATTERN
           (send nil? :task ...)

manual/cops_rails.md

@@ -1666,16 +1666,16 @@ Enabled by default | Safe | Supports autocorrection | VersionAdded | VersionChan
 --- | --- | --- | --- | ---
 Enabled | No | No | 2.4 | -
 
-This cop checks rake task definition without `environment` dependency.
-`environment` dependency is important because it loads application code
-for the rake task. The rake task cannot use application code, such as
-models, without `environment` dependency.
+This cop checks for Rake tasks without the `:environment` task
+dependency. The `:environment` task loads application code for other
+Rake tasks. Without it, tasks cannot make use of application code like
+models.
 
 You can ignore the offense if the task satisfies at least one of the
 following conditions:
 
 * The task does not need application code.
-* The task invokes :environment task.
+* The task invokes the `:environment` task.
 
 ### Examples
 

spec/rubocop/cop/rails/rake_environment_spec.rb

@@ -8,7 +8,7 @@
   it 'registers an offense to task without :environment' do
     expect_offense(<<~RUBY)
       task :foo do
-      ^^^^^^^^^ Set `:environment` task as a dependency to all rake task.
+      ^^^^^^^^^ Include `:environment` task as a dependency for all Rake tasks.
       end
     RUBY
   end