Add guidelines for how to use magic comments #616
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
bbatsov
reviewed
Jan 8, 2017
|
|
||
| * <a name="magic-comments-first"></a> | ||
| Place magic comments above all code and documentation. Magic comments should only go below shebangs if they are needed in your source file. | ||
| <sup>[[link](#magic-comments-first)]</sup> |
There was a problem hiding this comment.
I'd add some code examples here as well.
|
@bbatsov updated with another example |
11 tasks
backus
added a commit
to backus/rubocop
that referenced
this pull request
Jan 24, 2017
bbatsov
pushed a commit
to rubocop/rubocop
that referenced
this pull request
Jan 25, 2017
koic
pushed a commit
to rubocop/rubocop-rails
that referenced
this pull request
Oct 26, 2018
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.
See rubocop/rubocop#3285 for previous discussion about magic comments. See rubocop/rubocop#3879 if you are interested in the rules for magic comments with multiple instructions (a mostly undocumented ruby feature AFAICT).