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

Documentation is replaced by auto-generated RBI comments. #17167

Closed
3 tasks done
reitermarkus opened this issue Apr 27, 2024 · 6 comments
Closed
3 tasks done

Documentation is replaced by auto-generated RBI comments. #17167

reitermarkus opened this issue Apr 27, 2024 · 6 comments
Assignees
Labels
bug Reproducible Homebrew/brew bug outdated PR was locked due to age

Comments

@reitermarkus
Copy link
Member

brew doctor output

N/A

Verification

  • My "brew doctor output" above says Your system is ready to brew. and am still able to reproduce my issue.
  • I ran brew update twice and am still able to reproduce my issue.
  • This issue's title and/or description do not reference a single formula e.g. brew install wget. If they do, open an issue at https://github.com/Homebrew/homebrew-core/issues/new/choose instead.

brew config output

N/A

What were you trying to do (and why)?

Documentation for e.g. RuboCops only shows auto-generated comments from RBI files:

From https://rubydoc.brew.sh/RuboCop/Cop/Homebrew/Blank.html:

DO NOT EDIT MANUALLY This is an autogenerated file for dynamic methods in RuboCop::Cop::Homebrew::Blank. Please instead update this file by running bin/tapioca dsl RuboCop::Cop::Homebrew::Blank.

What happened (include all command output)?

I assume the reason is that yard-sorbet is run last. It should be changed to skip any comments in RBI files.

What did you expect to happen?

Original documentation should be shown.

Step-by-step reproduction instructions (by running brew commands)

1. `brew rubydoc --open`
1. Look at `RuboCop::Cop::Homebrew::Blank` documentation.
@dduugg
Copy link
Member

dduugg commented Apr 28, 2024

I opened a PR upstream: Shopify/tapioca#1885 🤞

@MikeMcQuaid
Copy link
Member

Thanks for issues @reitermarkus and @dduugg!

@dduugg
Copy link
Member

dduugg commented Apr 30, 2024

We can also patch Tapioca if upstream doesn't accept the patch (early feedback isn't positive) 🙈. Something like: https://github.com/Homebrew/brew/compare/tapioca-patch?expand=1

@MikeMcQuaid
Copy link
Member

We can also patch Tapioca if upstream doesn't accept the patch (early feedback isn't positive) 🙈. Something like: tapioca-patch?expand=1 (compare)

@dduugg This would work fine for me, monkey-patching like this is IMO fairly inconsequential when we're not exposing it to end-users.

@reitermarkus
Copy link
Member Author

@dduugg, fine by me. We can always revert it once it is fixed upstream.

@dduugg
Copy link
Member

dduugg commented May 1, 2024

Upstream PR was accepted, this will be fixed in the next tapioca release

@dduugg dduugg closed this as completed May 1, 2024
@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.
Labels
bug Reproducible Homebrew/brew bug outdated PR was locked due to age
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants