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

Add clarifying comments to rubocop:disables #19084

Merged
merged 2 commits into from
Jan 13, 2025

Conversation

issyl0
Copy link
Member

@issyl0 issyl0 commented Jan 12, 2025

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

cask/artifact/abstract_artifact.rb:58:28: C: Cop/DisableComment: Add a clarifying comment to the RuboCop disable comment
        @@sort_order ||= [ # rubocop:disable Style/ClassVars
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
download_strategy.rb:711:24: C: Cop/DisableComment: Add a clarifying comment to the RuboCop disable comment
  def initialize(path) # rubocop:disable Lint/MissingSuper
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
lazy_object.rb:13:5: C: Cop/DisableComment: Add a clarifying comment to the RuboCop disable comment
    # rubocop:disable Naming/MemoizedInstanceVariableName
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Needed for PR 18842 that adds a `DisableComment` RuboCop to ensure that all RuboCop disables have comments.
@issyl0 issyl0 mentioned this pull request Jan 12, 2025
7 tasks
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @issyl0! Left some comments for follow-up PRs but will merge this now to avoid conflicts.

Library/Homebrew/brew.rb Show resolved Hide resolved
Library/Homebrew/download_strategy.rbi Show resolved Hide resolved
@MikeMcQuaid
Copy link
Member

Left some comments for follow-up PRs but will merge this now to avoid conflicts.

Oh, would have done but CI is 🔴 😅

- I tried this as a previous approach to see if we could enable the rule, but it didn't work, then I forgot about it.
@issyl0 issyl0 enabled auto-merge January 13, 2025 11:18
@issyl0 issyl0 added this pull request to the merge queue Jan 13, 2025
Merged via the queue into master with commit 4c9de7d Jan 13, 2025
28 checks passed
@issyl0 issyl0 deleted the add-comments-to-rubocop-disables branch January 13, 2025 11:44
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.

2 participants