Unclear behaviour of RDoc::RI::Driver#initialize
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
Hello,
I think I found misleading comment or a bug.
Ri driver initialize method comment states that initial driver options come (partly) from result of process_args call. Thats not true because process_args is not called and instead passed options hash is merged with default_options (whitch is a method and also doesn't call process_args). Overall during driver initalization process_args doesn't seem to be called at all.
As a resuld RI env variable is not parsed (as the code that process it is in process_args) and its contents are ignored.
I'm not sure if it is desired behavior or just a orphaned comment.
Cheers
🍷
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in lib/rdoc/ri/driver.rb at line 403 and trace initialize, default_options, and process_args, especially RI environment handling. Confirm whether initialize should parse RI or whether the comment is wrong; done means the intended behavior is settled and the code and comment are made consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100