Skip to content

Commit

Permalink
Enable warn_missing_rdoc_ref by default (#1275)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
st0012 authored Jan 15, 2025
1 parent b795077 commit ce79711
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion lib/rdoc/options.rb
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,7 @@ def init_ivars # :nodoc:
@update_output_dir = true
@verbosity = 1
@visibility = :protected
@warn_missing_rdoc_ref = false
@warn_missing_rdoc_ref = true
@webcvs = nil
@write_options = false
@encoding = Encoding::UTF_8
Expand Down
2 changes: 1 addition & 1 deletion test/rdoc/test_rdoc_options.rb
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def test_to_yaml
'template_stylesheets' => [],
'title' => nil,
'visibility' => :protected,
'warn_missing_rdoc_ref' => false,
'warn_missing_rdoc_ref' => true,
'webcvs' => nil,
'skip_tests' => true,
'apply_default_exclude' => true,
Expand Down

0 comments on commit ce79711

Please sign in to comment.