Skip to content

Commit 4332678

Browse files
committed
docs(README): fix the example that doesn't work
```ruby RDoc::RDoc.new.document(RDoc::Options.new) ``` fails with the following error: ``` /Users/okuramasafumi/.rbenv/versions/3.4.1/lib/ruby/gems/3.4.0/gems/rdoc-6.12.0/lib/rdoc/options.rb:522:in 'RDoc::Options#check_files': undefined method 'delete_if' for nil (NoMethodError) ``` I think this should be fixed, but for now modifying an example might be enough.
1 parent 0e5a763 commit 4332678

File tree

1 file changed

+1
-4
lines changed

1 file changed

+1
-4
lines changed

README.rdoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,8 @@ To generate documentation programmatically:
5353
gem 'rdoc'
5454
require 'rdoc/rdoc'
5555

56-
options = RDoc::Options.new
57-
# see RDoc::Options
58-
5956
rdoc = RDoc::RDoc.new
60-
rdoc.document options
57+
rdoc.document([]) # This generates documentation for all files in the current directory
6158
# see RDoc::RDoc
6259

6360
You can specify the target files for document generation with +.document+ file in the project root directory.

0 commit comments

Comments
 (0)