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 #11293] Fix a false negative for Style/Documentation #11294

Merged

Conversation

koic
Copy link
Member

@koic koic commented Dec 16, 2022

Fixes #11293.

This PR fixes a false negative for Style/Documentation when using custom macro.

The built-in macros (e.g. include, extend, prepend) and DSL like belongs_to should be treated differently. Only include, extend, and prepend will be needed to resolve #8788.


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.

Fixes rubocop#11293.

This PR fixes a false negative for `Style/Documentation`
when using custom macro.

The built-in macros (e.g. `include`, `extend`, `prepend`) and
DSL like `belongs_to` should be treated differently.
Only `include`, `extend`, and `prepend` will be needed to resolve rubocop#8788.
@koic koic force-pushed the fix_false_negative_for_style_documentation branch from 57286a4 to bac3f74 Compare December 16, 2022 04:11
@bbatsov
Copy link
Collaborator

bbatsov commented Dec 17, 2022

I think it will also be a good idea to update the docs to reflect more precisely what's allowed when it comes to macros, as right now the documentation is extremely basic in this regard.

@bbatsov
Copy link
Collaborator

bbatsov commented Dec 20, 2022

@koic Ping :-)

@koic
Copy link
Member Author

koic commented Dec 20, 2022

I'm not sure if this change should be documented. It essentially looks like #8812's bug against #8788.
This is because it seems redundant to document that extend Bar does not require comments.

module Foo
  # documentation.
  module Bar
  end

  extend Bar
end

So, I think it's clear that this cop doesn't require documentation for extend Bar.

@bbatsov bbatsov merged commit e8f54c4 into rubocop:master Dec 20, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented Dec 20, 2022

Okay, fair enough.

@koic koic deleted the fix_false_negative_for_style_documentation branch December 20, 2022 10:56
@ghiculescu
Copy link
Contributor

Thank you!!

koic added a commit that referenced this pull request Jan 13, 2023
Fixes #11434.

This commit removes an erroneous `@api private` mark for `RuboCop::Formatter`
introduced in #11294.
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.

Style/Documentation macro-only check is incorrect Style/Documentation with only macros
3 participants