Restyle the example formatting for some Layout cops #4978
Merged
Conversation
This file contains hidden or 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
Follow up of rubocop#4880 (comment). This commit is a change of document format. Because there are many cops to be changed, this commit applied a new style to some Layout department cops first.
bbatsov
reviewed
Nov 2, 2017
| # | ||
| # @example | ||
| # # Good if EnforcedStyle is no_space, bad if space. | ||
| # @example EnforcedStyle no_space (default) |
There was a problem hiding this comment.
You forgot : here and in the other example.
There was a problem hiding this comment.
Oops. I fixed by #4994. Thanks for the review 💦
|
Great change! It just reveals one small problem of the current approach - we're not extracting the example's name where converting it to the manual's snippet and some valuable info for the end user gets lost. We should improve the code of the manual generator to account for this. (should be trivial) |
koic
added a commit
to koic/rubocop
that referenced
this pull request
Nov 4, 2017
Follow up of rubocop#4978 (comment). This is a small fix to the document of `Layout/SpaceInsideStringInterpolation` cop.
11 tasks
bbatsov
pushed a commit
that referenced
this pull request
Nov 4, 2017
Follow up of #4978 (comment). This is a small fix to the document of `Layout/SpaceInsideStringInterpolation` cop.
11 tasks
koic
added a commit
to koic/rubocop
that referenced
this pull request
Nov 6, 2017
Follow up of rubocop#4880 (comment). This commit applied a new style to some `Style` department cops, the same policy as rubocop#4978.
bbatsov
pushed a commit
that referenced
this pull request
Nov 7, 2017
Follow up of #4880 (comment). This commit applied a new style to some `Style` department cops, the same policy as #4978.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Follow up of #4880 (comment).
This commit is a change of document format.
Because there are many cops to be changed 💦, this commit applied a new style to some Layout department cops first.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).rake spec) are passing.rake internal_investigation.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).