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

Fix Style/RedundantBegin removing comments on assignment statement correction #9639

Merged
merged 1 commit into from Mar 29, 2021

Conversation

marcotc
Copy link
Contributor

@marcotc marcotc commented Mar 25, 2021

Style/RedundantBegin cop currently removes comments that occur
before the first child node of the begin block. This happens
because comments are skipped when navigating the node tree.

Currently,

var ||= begin
  # comment
  foo
end

will correct to

var ||= foo

This PR changes that correction to

# comment
var ||= foo

Other comments in the vicinity (before and after begin/end block,
and after first child node) are still preserved, as they
already were before this change.


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.

…correction

`Style/RedundantBegin` cop currently removes comments that occur
before the first child node of the `begin` block. This happens
because comments are skipped when navigating the node tree.

Currently,
```ruby
var ||= begin
  # comment
  foo
end
```
will correct to
```ruby
var ||= foo
```

This PR changes that correction to
```ruby
var ||= foo
```

Other comments in the vicinity (before and after `begin/end` block,
and after first child node) are still preserved, as they
already were before this change.
@koic koic merged commit 8110f8f into rubocop:master Mar 29, 2021
@koic
Copy link
Member

koic commented Mar 29, 2021

Thanks!

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