ruby / ruby/rdoc

6.5.0 fails to properly parse ruby-3.2.0 source directory

Open
#959 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

$ ruby -v
ruby 3.2.0 (2022-12-25 revision a528908271) [x86_64-linux]

$ gem install rdoc -v 6.5.0
$ gem install rdoc -v 6.4.0

$ wget https://cache.ruby-lang.org/pub/ruby/3.2/ruby-3.2.0.tar.gz
$ tar xf ruby-3.2.0.tar.gz
$ cd ruby-3.2.0

Then, testing with v6.5.0 yields:

$ rdoc _6.5.0_ -r -o 650
$ find 650 -type f | wc -l
81

which is obviously not quite right.

But with v6.4.0 everything seems to work fine:

$ rdoc _6.4.0_ -r -o 640
$ find 640 -type f | wc -l
11227

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the report with the Ruby 3.2.0 source and the two installed RDoc versions using the commands in the issue. Trace RDoc's source-parsing entry point to determine why 6.5.0 generates only 81 files, then verify the fix by rerunning the command and restoring output comparable to 6.4.0's 11,227 files.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.