Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't assume first and last comments are aligned #12366

Merged
merged 1 commit into from Nov 7, 2023

Conversation

eugeneius
Copy link
Contributor

Currently we use each_cons(3) to find comments that align with their neighbours, but this means the first and last comments aren't checked. We treat them as always aligned, but this leads to false negatives.

We can instead use each_cons(2) to look at each pair of comments and add both if they're aligned. This does mean that sometimes lines are added twice, but this is fine since Set#<< is idempotent.


Before submitting the PR make sure the following are checked:

  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Wrote good commit messages.
  • Commit message starts with [Fix #issue-number] (if the related issue exists).
  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • Added tests.
  • Ran bundle exec rake default. It executes all tests and runs RuboCop on its own code.
  • Added an entry (file) to the changelog folder named {change_type}_{change_description}.md if the new code introduces user-observable changes. See changelog entry format for details.

Currently we use `each_cons(3)` to find comments that align with their
neighbours, but this means the first and last comments aren't checked.
We treat them as always aligned, but this leads to false negatives.

We can instead use `each_cons(2)` to look at each pair of comments and
add both if they're aligned. This does mean that sometimes lines are
added twice, but this is fine since `Set#<<` is idempotent.
@koic koic merged commit 2d48430 into rubocop:master Nov 7, 2023
28 checks passed
@koic
Copy link
Member

koic commented Nov 7, 2023

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants