rubocop: Only enable Style/Documentation for @api public code
#14818
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Review period will end on 2023-02-28 at 00:00:00 UTC. |
BrewTestBot
added
the
waiting for feedback
issyl0
commented
Feb 26, 2023
issyl0
force-pushed
the
rubocop-documentation
branch
from
87fc569
to
802aab3
Compare
MikeMcQuaid
reviewed
Feb 27, 2023
There was a problem hiding this comment.
This is nice! Would be also cool if we could somehow detect if private APIs are used in brew style one day (not in this PR!) so we can warn about them (CC @dduugg for @Bo98 if you have any ideas).
Found the public API paths with git grep -l "@api public".
The only thing I wonder here is if it'd be nice to turn the above, in this PR, into a CI check so stop this list getting out of sync?
MikeMcQuaid
reviewed
Feb 27, 2023
BrewTestBot
removed
the
waiting for feedback
|
Review period ended. |
BrewTestBot
approved these changes
Feb 28, 2023
- Suggested in Homebrew#14709 (comment). - Found the public API paths with `git grep -l "@api public"`.
issyl0
force-pushed
the
rubocop-documentation
branch
from
03145ca
to
746dd44
Compare
- This `Homebrew/utils.rb` file contains one `@api public` method so it's now included in `Style/Documentation`. - This method not having a comment was causing the style specs to fail because this file isn't usually failing RuboCop. - And the test description was confusing so I improved it.
- This is better in the `Library/Homebrew/.rubocop.yml` since it's operating on files that are within that directory.
- This will stop the `Style/Documentation` filepath includes getting out of sync with what we declare as a public API, thus ensuring that everything is documented. - Maybe we could also add a job here to check that _all_ the paths in the RuboCop config still exist, but that's for another time.
- The `Kernel` module, which needed a comment because it has an "@api public" method in it, moved.
issyl0
force-pushed
the
rubocop-documentation
branch
from
746dd44
to
033daca
Compare
Done! |
MikeMcQuaid
reviewed
Feb 28, 2023
MikeMcQuaid
reviewed
Feb 28, 2023
MikeMcQuaid
reviewed
Feb 28, 2023
Co-authored-by: Mike McQuaid <mike@mikemcquaid.com>
- The slowest part of the separate workflow was the repo checkout step, so include it in here to avoid the overhead.
MikeMcQuaid
approved these changes
Feb 28, 2023
MikeMcQuaid
reviewed
Feb 28, 2023
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
brew stylewith your changes locally?brew typecheckwith your changes locally?brew testswith your changes locally?git grep -l "@api public".