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

Include .rbi shims in yard docs #16906

Merged
merged 1 commit into from
Mar 18, 2024
Merged

Conversation

dduugg
Copy link
Member

@dduugg dduugg commented Mar 18, 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?

Per https://github.com/dduugg/yard-sorbet/blob/main/README.md we can merge the RBI sigs with source code documentation. The add'l time is ~negligible (27s now, 24s before). This also bumps the documentation level from 60.3% to 63.5%.

Before:
image

Homebrew::CLI::Args instance methods after:
image

@@ -6,6 +6,7 @@ class Hash
# This includes the values from the root hash and from all
# nested hashes and arrays.
#
# @example
Copy link
Member Author

Choose a reason for hiding this comment

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

Resolves

[warn]: In file `extend/hash/deep_transform_values.rb':12: Cannot resolve link to person: from text:
	...{person: {name: “ROB”, age: “28”}...

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.

Much nicer, great work @dduugg!

@MikeMcQuaid MikeMcQuaid merged commit af8b105 into Homebrew:master Mar 18, 2024
26 checks passed
@github-actions github-actions bot added the outdated PR was locked due to age label Apr 18, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 18, 2024
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.

2 participants