This repository has been archived by the owner on Jul 31, 2023. It is now read-only.
Clarify rubocop configuration for 'lint: true' #492
Merged
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
…clarify actual behavior
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
"lint": trueflag on the rubocop configuration for linting runs the rubocop command with the-lflag. The rubocop documentation describes this flag with "Run only lint cops". However, the readme here describes the configuration as "enable all lint cops". This discrepancy led myself and some of my co-workers to believe that this configuration was required to enable any lint checks at all, and we were confused as to why many checks were not being performed with this config option set to true. This pr updates the description of the configuration to be more in line with the rubocop documentation.