ruby / ruby/rdoc

Make stdlib and core `ri` show before installed gems

Open
#273 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

When I do ri encode, the encode methods from core should be displayed first, followed by stdlib, then installed gems. I am not sure what order it is in today, but when I do ri encode I rarely care about the "Implementation from Behavior in actionmailer".

I am using rdoc-4.1.0.preview.3. Here is a video to show you what I mean. I know I can do ri String#encode, but I think ri should sort output by "stuff that's most frequently used" which would be core, stdlib, then installed gems.

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

Start by tracing how the ri encode command discovers and orders matching documentation across core, stdlib, and installed gems. Compare the current output with the requested priority, and consider the behavior shown in the linked video. Done means core methods appear first, followed by stdlib and then installed gems.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
cli, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.