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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

theodorton
Copy link

@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 3 times, most recently from c6390f9 to 4b9bcda Compare March 24, 2024 08:49
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

1 participant