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

Hide #inspect and #to_s in docs. #17157

Merged
merged 4 commits into from Apr 26, 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?

Every Object has these methods, so don't explicitly show them in docs.

@EricFromCanada
Copy link
Member

Is it possible to use query filters to hide methods with those names at build time?

@reitermarkus
Copy link
Member Author

@EricFromCanada, it's probably possible to hide these in a similar way as in #16831, but I'd rather get that merged first to avoid conflicts.

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.

Agree it'd be nice to handle this more automatically but this seems fine for now to get the other PR moving forward. Thanks @reitermarkus for the PR and @EricFromCanada for the review!

@EricFromCanada
Copy link
Member

@reitermarkus Just adding this to .yardopts will do the trick: --query 'object.name != :inspect && object.name != :to_s'

@MikeMcQuaid MikeMcQuaid merged commit ee4499f into Homebrew:master Apr 26, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants