Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Warn about undocumented non-private APIs. #17165

Merged
merged 3 commits into from
May 1, 2024

Conversation

reitermarkus
Copy link
Member

@reitermarkus reitermarkus commented Apr 26, 2024

  • 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
@reitermarkus reitermarkus force-pushed the docs-private-by-default branch from b0f793a to 4b8a2c4 Compare April 28, 2024 18:52
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.

@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 force-pushed the docs-private-by-default branch from 9e4ae19 to 480e264 Compare May 1, 2024 09:35
@reitermarkus reitermarkus enabled auto-merge May 1, 2024 09:38
@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
Revert one change from #17165.

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

Fixes #17203
@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
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants