Skip reordering positional arguments for include_* in RSpec/SortMetadata #1437
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
pirj
changed the title
pirj
force-pushed
the
fix-mistaken-positional-arguments-reordering
branch
from
ddfd4a3 to
db7b7f4
Compare
5 tasks
pirj
force-pushed
the
fix-mistaken-positional-arguments-reordering
branch
from
db7b7f4 to
2d9658a
Compare
|
@pirj Are you saying we should disable / remove this cop again? I am myself having second thoughts about its usefulness. |
|
🤷♂️
I don’t have a strong opinion here, as I’m not a heavy metadata user.
|
bquorning
approved these changes
Oct 25, 2022
bquorning
added a commit
that referenced
this pull request
Oct 25, 2022
…ts-reordering Skip reordering positional arguments for include_* in RSpec/SortMetadata
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.
fixes #1435
The arguments to
include_examplesis not regular metadata, it's arguments passed to the shared groups.We should not reorder positional arguments, and reordering hash arguments can also have side effects, e.g. for
.eachandkeys.first.See 2.3 of this reference.
It might make sense to still reorder metadata of configuration-level
include_context, but I'd rather skip that.Before submitting the PR make sure the following are checked:
master(if not - rebase it).CHANGELOG.mdif the new code introduces user-observable changes.bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).