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.

Sign up for GitHub

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

Jump to bottom

Warn about undocumented non-private APIs. #17165

Merged
merged 3 commits into from
May 1, 2024
Merged

Warn about undocumented non-private APIs. #17165

merged 3 commits into from
May 1, 2024

Conversation

reitermarkus
Copy link
Member

@reitermarkus reitermarkus commented Apr 26, 2024 •
edited

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

All non-private APIs should actually be documented, not just marked.

Also, automatically hide #hash, #inspect and #to_s, as well as automatically add @deprecated based on odeprecated/disabled.

@reitermarkus reitermarkus force-pushed the docs-private-by-default branch 7 times, most recently from 1a9d196 to b0f793a Compare April 28, 2024 01:21
@reitermarkus reitermarkus marked this pull request as draft April 28, 2024 03:07
MikeMcQuaid
MikeMcQuaid approved these changes Apr 29, 2024
View reviewed changes
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.

Great work again @reitermarkus, appreciate you getting these docs looking nicer/better.

Library/Homebrew/cask/dsl.rb Outdated Show resolved Hide resolved
@MikeMcQuaid
Copy link
Member

👍🏻 to 🚢 once CI is 🟢

@reitermarkus reitermarkus force-pushed the docs-private-by-default branch 9 times, most recently from 2ed4a38 to 9e4ae19 Compare May 1, 2024 09:35
@reitermarkus reitermarkus marked this pull request as ready for review May 1, 2024 09:35
@reitermarkus reitermarkus merged commit e479f4b into Homebrew:master May 1, 2024
35 checks passed
@reitermarkus reitermarkus deleted the docs-private-by-default branch May 1, 2024 09:46
MikeMcQuaid added a commit that referenced this pull request May 3, 2024
@MikeMcQuaid
formula: fix missing test resources.
9da18b6 
Revert one change from #17165.

It's unclear to me why this fixes the problem, but it does.

Fixes #17203
@MikeMcQuaid MikeMcQuaid mentioned this pull request May 3, 2024
Merged
@github-actions github-actions bot added the outdated PR was locked due to age label Jun 1, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@apainintheneck apainintheneck apainintheneck left review comments

@MikeMcQuaid MikeMcQuaid MikeMcQuaid approved these changes

Assignees
No one assigned
Labels
outdated PR was locked due to age
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@reitermarkus @MikeMcQuaid @apainintheneck