Mark Performance/Sum auto-correction as unsafe and extend documentation
#270
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
leoarnold
force-pushed
the
leoarnold/sum-doc
branch
from
61040cd
to
1c3f378
Compare
leoarnold
changed the title
Performance/Sum auto-correction as unsafe and extend documenta…Performance/Sum auto-correction as unsafe and extend documentation
leoarnold
force-pushed
the
leoarnold/sum-doc
branch
from
1c3f378
to
66a3cf7
Compare
koic
reviewed
Nov 16, 2021
koic
reviewed
Nov 16, 2021
leoarnold
force-pushed
the
leoarnold/sum-doc
branch
2 times, most recently
from
4331292
to
00df7fb
Compare
|
Can you rebase with the latest master branch to resolve conflicts? |
…tion The documentaion of `Performance/Sum` talked about setting `SafeAutoCorrect: true` for the cop, but Rubocop complained: ``` Warning: Performance/Sum does not support SafeAutoCorrect parameter. Supported parameters are: - Enabled ``` so we add the `SafeAutoCorrect` option to the cop's defaults and thereby mark it as (partially) unsafe. This is NOT a change in behavior: The cop will still perform all safe auto-corrections when using `-a`, and also (by default) perform all unsafe auto-corrections when using `-A`. Furthermore we extend the documentation in order to make it even more clear in _which_ cases auto-correction is unsafe, and _why_.
leoarnold
force-pushed
the
leoarnold/sum-doc
branch
from
00df7fb
to
b1eb508
Compare
|
@koic Done. |
|
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.
The documentaion of
Performance/Sumtalked about settingSafeAutoCorrect: truefor the cop, but Rubocop complained:so we add the
SafeAutoCorrectoption to the cop's defaultsand thereby mark it as (partially) unsafe.
This is NOT a change in behavior: The cop will still perform all
safe auto-corrections when using
-a, and also (by default)perform all unsafe auto-corrections when using
-A.Furthermore we extend the documentation in order to make it even more
clear in which cases auto-correction is unsafe, and why.
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.and description in grammatically correct, complete sentences.
bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.