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

Add AllowComments option to Style/RedundantInitialize #10551

Conversation

koic
Copy link
Member

@koic koic commented Apr 20, 2022

Follow up #10524 (comment).

This PR add AllowComments option to Style/RedundantInitialize is true by default.

# AllowComments: true (default)

# good
def initialize
  # Overriding to negate superclass `initialize` method.
end

# AllowComments: false

# bad
def initialize
  # Overriding to negate superclass `initialize` method.
end

This cop has been reported as false positive and has already been marked as unsafe. In addition, cases such as the follow up address have been reported. This PR allows intentional overrides with explicit comments to be allowed by default.


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.

Follow up rubocop#10524 (comment).

This PR add `AllowComments` option to `Style/RedundantInitialize` is true by default.

```ruby
# AllowComments: true (default)

# good
def initialize
  # Overriding to negate superclass `initialize` method.
end

# AllowComments: false

# bad
def initialize
  # Overriding to negate superclass `initialize` method.
end
```

This cop has been reported as false positive and has already been marked as unsafe.
In addition, cases such as the follow up address have been reported. This PR allows
intentional overrides with explicit comments to be allowed by default.
@koic koic force-pushed the add_allow_comments_option_for_style_redundant_initialize branch from d1d8032 to edcc7e5 Compare Apr 20, 2022
@bbatsov bbatsov merged commit 530d12f into rubocop:master Apr 20, 2022
34 checks passed
@bbatsov
Copy link
Collaborator

bbatsov commented Apr 20, 2022

Thanks!

@koic koic deleted the add_allow_comments_option_for_style_redundant_initialize branch Apr 20, 2022
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