Add a link to Layout/EmptyLineAfterMagicComment #9881
Merged
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.
I didn't know that this was a "magic" comment, and that
Layout/EmptyLineAfterMagicComment
was the way to require a blank line after thefrozen_string_literal
comment.I think it would be useful for the documentation to point people in the right direction.
Is there a special syntax like
@see
or something, for linking between these doc pages?Before submitting the PR make sure the following are checked:
[Fix #issue-number]
(if the related issue exists). # N/Amaster
(if not - rebase it).bundle exec rake default
. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.md
if the new code introduces user-observable changes. See changelog entry format for details. # N/A