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

Enable warn_missing_rdoc_ref by default #1275

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Jan 12, 2025

This feature has been tested in RDoc and IRB, as well as my local Ruby project for a while. It's been finding and now preventing dead rdoc-ref links effectively. So I think it's a great feature to be enabled by default.

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
This feature has been tested in RDoc and IRB, as well as my local
Ruby project for a while. It's been finding and now preventing dead
rdoc-ref links effectively. So I think it's a great feature to
be enabled by default.
@st0012 st0012 self-assigned this Jan 12, 2025
@st0012 st0012 requested a review from nobu January 12, 2025 21:36
@st0012
Copy link
Member Author

st0012 commented Jan 12, 2025

@nobu instead of just enabling it in ruby/ruby with ruby/ruby#12510, and then let different RDoc users slowly picking the configuration up, I think we can just enable it in RDoc by default. WDYT?

Copy link
Collaborator

@vinistock vinistock left a comment

Choose a reason for hiding this comment

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

This doesn't fail the RDoc generation process, so I don't see any reason why it wouldn't be turned on by default

@st0012 st0012 merged commit ce79711 into master Jan 15, 2025
47 checks passed
@st0012 st0012 deleted the enable-missing-rdoc-ref-by-default branch January 15, 2025 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants