ruby / ruby/rdoc

ri Foo::CONST doesn't work

Open
#179 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Use the following example:

# foo.rb
module Foo
  BAR = "omg"
end

$ rdoc -ro tmp foo.rb

Now try to read Foo::BAR with ri:

$ ri -d tmp Foo::BAR #=> Nothing known about Foo::BAR

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 issue with the shown foo.rb example, then run rdoc -ro tmp foo.rb and ri -d tmp Foo::BAR to confirm the missing lookup. Trace the ri lookup entry point and constant documentation handling; done means ri displays documentation for Foo::BAR from the generated data.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.