-
-
Notifications
You must be signed in to change notification settings - Fork 9.9k
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
rubocop: Try out rubocop-md
for linting the code in our docs
#16518
Conversation
|
I figured it out! I was missing |
I'm kind of surprised that the number of offenses is so low. |
Oh, CI passing isn't representative, I've not got this working yet, but locally there are still 60-odd problems. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good so far, thanks @issyl0!
c759444
to
37fad74
Compare
- This could be useful for linting code in our docs.
- Blocks should open with `do` and close with `end`. - `...` is not valid Ruby syntax, so comment it out so that the user knows that it's a placeholder for "other things here". - Reword the "header line details" in `Cask-Cookbook` otherwise RuboCop crashes even with an `end` because of the empty block. There was already an example of a valid header line in the first code block on the page, so it's not a big loss.
- Let's see how this goes.
- T::Sig hasn't been needed in every file for a long time.
- Yes, we have yet another `.rubocop.yml` but in-line exclusions in `<span class="display:none;">` in the Markdown seemed more ugly. - This needed tweaks to `brew style` to make it read the new config file when we're scanning docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking great so far, thanks @issyl0!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good, a few nits, thanks @issyl0!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! One suggestion, non-blocking.
- We don't need this blanket enabled, we only have a few docs where it actually matters that there's a description, it's just cruft having to invent descriptions.
brew style
with your changes locally?brew typecheck
with your changes locally?brew tests
with your changes locally?