Copyedit Rails/RakeEnvironment cop documentation. #164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andyw8
reviewed
Dec 4, 2019
| @@ -334,7 +334,7 @@ Rails/Present: | |||
| UnlessBlank: true | |||
|
|
|||
| Rails/RakeEnvironment: | |||
| Description: 'Set `:environment` task as a dependency to all rake task.' | |||
There was a problem hiding this comment.
Maybe also capitalize Rake here?
There was a problem hiding this comment.
Good catch, thank you.
andyw8
reviewed
Dec 4, 2019
| # models, without `environment` dependency. | ||
| # This cop checks for Rake tasks without the `environment` dependency. The | ||
| # `environment` task loads application code for other Rake tasks. Without | ||
| # it, tasks cannot make use application code like models. |
dylnclrk
force-pushed
the
edit-rake-environment-copy
branch
2 times, most recently
from
1eec660 to
4eb039f
Compare
koic
reviewed
Dec 5, 2019
| # `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` dependency. The |
There was a problem hiding this comment.
I think that the document will be more consistent with :environment task.
-This cop checks for Rake tasks without the `environment` dependency. The
+This cop checks for Rake tasks without the `:environment` task dependency. TheThere was a problem hiding this comment.
Great idea. I made the change
koic
reviewed
Dec 5, 2019
| # 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` dependency. The | ||
| # `environment` task loads application code for other Rake tasks. Without |
There was a problem hiding this comment.
-# `environment` task loads application code for other Rake tasks. Without
+# `:environment` task loads application code for other Rake tasks. Without
koic
reviewed
Dec 5, 2019
| # | ||
| # 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. |
There was a problem hiding this comment.
-# * The task invokes the :environment task.
+# * The task invokes the `:environment` task.
dylnclrk
force-pushed
the
edit-rake-environment-copy
branch
from
4eb039f to
95b1746
Compare
* Tweak wording of offense message and supporting documentation to increase readability.
dylnclrk
force-pushed
the
edit-rake-environment-copy
branch
from
95b1746 to
e43c772
Compare
|
Should I add a note about this in the changelog? |
|
No changelog entry is required for this change. Thank you for the improvement! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The new
Rails/RakeEnvironmenttask from @pocke is great! 😄 But there are a few copy edits that could make the offense more readable.This PR tweaks the wording of the offense and supporting documentation to increase readability. This is somewhat subjective, so let me know what you think!
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).AddedUpdated existing tests.and description in grammatically correct, complete sentences.
bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.