ruby / ruby/rdoc

Link to Plurals of class names

Open
#10 2 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

As requested, I'm opening an issue based upon this ruby forum thread:

http://www.ruby-forum.com/topic/931304#976952

This is kinda going to be a slippery slope I'm afraid. I guess you could do a simple "remove the trailing s" and look. But a general way to link to the Class's page would be nice too so that I can do "list of children[class_link:Child]" (perhaps) and RDoc would fill in the proper link to the page for Child.

Good luck!
pedz

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 reading the linked Ruby forum thread and examining RDoc's existing class-page linking behavior. Clarify whether the goal is plural class-name lookup, an explicit class_link syntax, or both; done should mean the chosen behavior reliably links references such as Child to the corresponding class page.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.