8000 Do not group accessors having rbs-inline annotations in `Style/AccessorGrouping` by tk0miya · Pull Request #13221 · rubocop/rubocop · GitHub
[go: up one dir, main page]

Skip to content

Do not group accessors having rbs-inline annotations in Style/AccessorGrouping #13221

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

Merged
merged 1 commit into from
Sep 29, 2024

Conversation

tk0miya
Copy link
Contributor
@tk0miya tk0miya commented Sep 11, 2024

rbs-inline is a utility to embed RBS type declarations into Ruby code as comments.

This avoids to group accessors having rbs-inline annotation comments in Style/AccessorGrouping.

refs: https://github.com/soutaro/rbs-inline/wiki/Syntax-guide


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.

@koic
Copy link
Member
koic commented Sep 11, 2024

It would be good to add information about accepting RBS::Inline annotation comment to this cop's documentation.

@tk0miya tk0miya force-pushed the rbs-inline/accessor_grouping branch 2 times, most recently from 3cb1b30 to fab576e Compare September 11, 2024 14:51
@tk0miya
Copy link
Contributor Author
tk0miya commented Sep 11, 2024

@koic Thank you for the quick and exact review!

…sorGrouping`

[RBS::Inline](https://github.com/soutaro/rbs-inline) is a utility to embed
RBS type declarations into Ruby code as comments.

This avoids to group accessors having RBS::Inline annotation comments in
`Style/AccessorGrouping`.

refs: https://github.com/soutaro/rbs-inline/wiki/Syntax-guide
@tk0miya tk0miya force-pushed the rbs-inline/accessor_grouping branch from fab576e to ed8249f Compare September 11, 2024 14:53
@bbatsov bbatsov merged commit 6c157a0 into rubocop:master Sep 29, 2024
22 checks passed
@bbatsov
Copy link
Collaborator
bbatsov commented Sep 29, 2024

Seems like a reasonable change. Thanks!

@tk0miya tk0miya deleted the rbs-inline/accessor_grouping branch September 29, 2024 17:53
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.

3 participants
0