ruby / ruby/rdoc

ruby: docs not listed with `ri --list`

Open
#299 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

How is anyone supposed to know about the new doco?

It isn't in ri --help and isn't in ri --list. Hell... I had to guess at ruby: and was simply lucky.

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 inspecting how ri --help and ri --list assemble their available topics. Trace where the ruby: documentation entry should be registered, then verify that both commands mention it and that the new documentation can be discovered without guessing.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.