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 #5713] Be more explicit about how Style/CommentAnnotation works #8798

Merged
merged 1 commit into from
Sep 26, 2020

Conversation

dvandersluis
Copy link
Member

The consensus in the issue is that the cop is working as expected, but the documentation does not explain well enough. This change adds an explicit test for comment blocks, as well as a documentation note.

Closes #5713.


Before submitting the PR make sure the following are checked:

  • 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.
  • Added an entry to the Changelog if the new code introduces user-observable changes. See changelog entry format.
  • The PR relates to only one subject with a clear title and description in grammatically correct, complete sentences.
  • Run bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.

@bbatsov bbatsov merged commit 2a35e98 into rubocop:master Sep 26, 2020
@bbatsov
Copy link
Collaborator

bbatsov commented Sep 26, 2020

Thanks!

@dvandersluis dvandersluis deleted the style/comment-annotation branch January 18, 2021 20:42
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/CommentAnnotation reports only first of multiple offending lines
2 participants