Improve offense message for RSpec/IndexedLet
#1953
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
Ran into this offense and thought: > Where exactly does my name contain "index"? I believe this message format is more clear.
bquorning
approved these changes
Aug 26, 2024
pirj
approved these changes
Aug 26, 2024
pirj
reviewed
Aug 26, 2024
| @@ -48,8 +48,8 @@ class IndexedLet < Base | |||
| include AllowedIdentifiers | |||
| include AllowedPattern | |||
|
|
|||
| MSG = 'This `let` statement uses index in its name. Please give it ' \ | |||
| 'a meaningful name.' | |||
| MSG = 'This `let` statement uses `%<index>s` in its name. ' \ | |||
There was a problem hiding this comment.
Should we keep the work “index” eg “uses 3 index in its name”?
There was a problem hiding this comment.
index doesn't seem like the right word to use. I know the cop is called IndexedLet but I wonder if that is a misnomer, NumberedLet (or similar) seems more accurate to what it does.
Personally I would leave it as is but overall not that important to me if you want it changed. Let me know.
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.
Ran into this offense and thought:
Of course I got it eventually but I had to look up docs online. I believe this message format is more clear.
Before submitting the PR make sure the following are checked:
master(if not - rebase it).CHANGELOG.mdif the new code introduces user-observable changes.bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).