From 43326786f44001fb0e69605a38081453fb798f51 Mon Sep 17 00:00:00 2001 From: OKURA Masafumi Date: Sun, 23 Mar 2025 23:52:44 +0900 Subject: [PATCH] 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. --- README.rdoc | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.rdoc b/README.rdoc index 4ed94a4bf0..7729600887 100644 --- a/README.rdoc +++ b/README.rdoc @@ -53,11 +53,8 @@ To generate documentation programmatically: gem 'rdoc' require 'rdoc/rdoc' - options = RDoc::Options.new - # see RDoc::Options - rdoc = RDoc::RDoc.new - rdoc.document options + rdoc.document([]) # This generates documentation for all files in the current directory # see RDoc::RDoc You can specify the target files for document generation with +.document+ file in the project root directory.