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

Move YARD config into Library/Homebrew. #10969

Merged
merged 1 commit into from Apr 2, 2021

Conversation

reitermarkus
Copy link
Member

@reitermarkus reitermarkus commented Mar 30, 2021

  • 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?

Also add support for @api internal and improve message for @api private.

@BrewTestBot
Copy link
Member

Review period will end on 2021-03-31 at 02:41:10 UTC.

@BrewTestBot BrewTestBot added the waiting for feedback Merging is blocked until sufficient time has passed for review label Mar 30, 2021
@@ -0,0 +1,5 @@
<p class="note private">
<strong>This <%= object.type %> is part of a private API.</strong>
This <%= object.type %> may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This <%= object.type %> may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.
This <%= object.type %> should only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.

Copy link
Member Author

Choose a reason for hiding this comment

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

Why?

Copy link
Member

Choose a reason for hiding this comment

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

Should is stronger and used more often in RFCs. I don't feel strongly, though.


def internal
return unless object.has_tag?(:api)
return unless object.tag(:api).text == "internal"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
return unless object.tag(:api).text == "internal"
return if object.tag(:api).text != "internal"

@BrewTestBot
Copy link
Member

Review period ended.

@BrewTestBot BrewTestBot removed the waiting for feedback Merging is blocked until sufficient time has passed for review label Mar 31, 2021
BrewTestBot
BrewTestBot previously approved these changes Mar 31, 2021
MikeMcQuaid
MikeMcQuaid previously approved these changes Apr 1, 2021
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.

A few style suggestions but happy to ship this as-is.

BrewTestBot
BrewTestBot previously approved these changes Apr 2, 2021
@reitermarkus reitermarkus merged commit 0e71efb into Homebrew:master Apr 2, 2021
@reitermarkus reitermarkus deleted the yard branch April 2, 2021 21:48
@github-actions github-actions bot added the outdated PR was locked due to age label May 3, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants