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
Conversation
Review period will end on 2021-03-31 at 02:41:10 UTC. |
0567b26
to
437ef9b
Compare
@@ -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. |
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.
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. |
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.
Why?
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.
Should is stronger and used more often in RFCs. I don't feel strongly, though.
Library/Homebrew/yard/templates/default/docstring/html/internal.erb
Outdated
Show resolved
Hide resolved
|
||
def internal | ||
return unless object.has_tag?(:api) | ||
return unless object.tag(:api).text == "internal" |
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.
return unless object.tag(:api).text == "internal" | |
return if object.tag(:api).text != "internal" |
Review period ended. |
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.
A few style suggestions but happy to ship this as-is.
Library/Homebrew/yard/templates/default/docstring/html/internal.erb
Outdated
Show resolved
Hide resolved
6a59b87
brew style
with your changes locally?brew typecheck
with your changes locally?brew tests
with your changes locally?Also add support for
@api internal
and improve message for@api private
.