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

Remove NOTE tag from Rails/RedundantActiveRecordAllMethod description for readability #1185

Conversation

masato-bkn
Copy link
Contributor

@masato-bkn masato-bkn commented Nov 20, 2023

This PR removes NOTE tag from Rails/RedundantActiveRecordAllMethod description for readability.

The inline code written in the NOTE section is not being displayed in the RuboCop Rails documentation, making it difficult to read.
I think removing the NOTE tag would enhance the documentation's readability.


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.
  • If this is a new cop, consider making a corresponding update to the Rails Style Guide.

…on for readability

The inline code written in the NOTE section is not being displayed in the RuboCop documentation, making it difficult to read.
@koic koic merged commit 9d90b6c into rubocop:master Nov 20, 2023
11 checks passed
@masato-bkn masato-bkn deleted the adjust-rails-redundant-active-record-all-method branch November 20, 2023 12:10
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