Improve Style/FrozenStringLiteralComment message #3999
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
anniecodes
approved these changes
Feb 1, 2017
|
Noticed CI was red because of too-long lines. Fixed, sorry! |
bbatsov
reviewed
Feb 2, 2017
| @@ -12,7 +12,7 @@ class FrozenStringLiteralComment < Cop | |||
| include ConfigurableEnforcedStyle | |||
| include FrozenStringLiteral | |||
|
|
|||
| MSG = 'Missing frozen string literal comment.'.freeze | |||
| MSG = 'File must begin with "# frozen_string_literal: true".'.freeze | |||
There was a problem hiding this comment.
I think that's a bit confusing as well. The file should really begin with this - keep in mind there things like shebangs and other magic comments. Also - code snippets in messages should be in backticks, not double quotes.
There was a problem hiding this comment.
Ok. How about something like:
MSG = 'Comment must be present near top of file: `# frozen_string_literal: true`.'It's a difficult thing to phrase clearly without getting too wordy :/
There was a problem hiding this comment.
How about Missing magic comment ....? That seems clear enough to me.
There was a problem hiding this comment.
Works for me. Updated.
|
Thanks! 👍 |
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.
We've had a bunch of developers confused by the previous message; I think this one is more clear.
Specifically, unless the user knows about this specific cop being enabled, the annotation "Missing frozen string literal comment" on a line like
require 'test_helper'doesn't really educate them on how to proceed.Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists). (N/A)master(if not - rebase it).and description in grammatically correct, complete sentences.
rake generate_cops_documentation(required only when you've added a new cop or changed the configuration/documentation of an existing cop). (N/A)