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

Support autocorrection for Naming/InclusiveLanguage #11703

Conversation

koic
Copy link
Member

@koic koic commented Mar 15, 2023

This PR makes Naming/InclusiveLanguage support autocorrection when there is only one suggestion. When there are multiple suggestions, the best suggestion cannot be identified and will not be autocorrected.


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.

@bbatsov
Copy link
Collaborator

bbatsov commented Mar 18, 2023

This should be reflected in the cops documentation, otherwise people might struggle to understand how the autocorrection works.

This PR makes `Naming/InclusiveLanguage` support autocorrection
when there is only one suggestion.
When there are multiple suggestions, the best suggestion cannot be
identified and will not be autocorrected.
@koic koic force-pushed the support_autocorrection_for_naming_inclusive_language branch from 6b3f82d to 006a846 Compare March 18, 2023 15:32
@koic
Copy link
Member Author

koic commented Mar 18, 2023

Sure, the doc reflected for the autocorrection condition.

@bbatsov bbatsov merged commit 09e71c2 into rubocop:master Mar 18, 2023
12 checks passed
@bbatsov
Copy link
Collaborator

bbatsov commented Mar 18, 2023

Thanks!

@koic koic deleted the support_autocorrection_for_naming_inclusive_language branch March 18, 2023 16:01
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