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

Support Ruby 3 inline attribute visibility #1541

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

theodorton
Copy link
Contributor

@theodorton theodorton commented Mar 23, 2024

See https://redmine.ruby-lang.org/issues/17314

Description

Currently attributes defined with:

private attr_accessor :foo
protected attr_accessor :bar

Will be displayed as public attributes in the documentation.

These should be considered private/protected and not be included in the documentation.

When generating documentation, this warning is show:

[warn]: in YARD::Handlers::Ruby::VisibilityHandler: Undocumentable statement, cannot determine method name
	in file ...:

	1: private attr_accessor :foo

Completed Tasks

  • I have read the Contributing Guide.
  • The pull request is complete (implemented / written).
  • Git commits have been cleaned up (squash WIP / revert commits).
  • I wrote tests and ran bundle exec rake locally (if code is attached to PR).

@theodorton theodorton force-pushed the inline-attribute-visibility branch 4 times, most recently from 4b9bcda to 40204d2 Compare March 24, 2024 08:53
Copy link
Owner

@lsegal lsegal left a comment

Choose a reason for hiding this comment

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

Looks good

@theodorton
Copy link
Contributor Author

theodorton commented Aug 26, 2024

@lsegal I can look into the failing specs here and request a second review.

Edit: I just saw some of the Rubies were dropped from the CI matrix in main. I'll rebase.

@theodorton theodorton force-pushed the inline-attribute-visibility branch from 1e8b035 to 6e31a81 Compare August 26, 2024 07:10
@lsegal lsegal merged commit d1bc910 into lsegal:main Aug 26, 2024
18 checks passed
@lsegal
Copy link
Owner

lsegal commented Aug 26, 2024

Thanks for the work on this!

@theodorton theodorton deleted the inline-attribute-visibility branch August 26, 2024 07:19
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.

2 participants