ruby / ruby/rdoc

Review and possibly upstream `sdoc`'s RDoc patches

Open
#1,333 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

sdoc being one of the major users of rdoc has patches to workaround issues/enhance features, which @jonathanhefner compiled in this comment. We should review them and adopt the ones that make sense for rdoc users in general.

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 sdoc patch list in the linked comment on pull request #1330 and compare each proposal with RDoc's current behavior. Determine which patches benefit RDoc users generally; done means the applicable changes are agreed, implemented, and validated with relevant checks.

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
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.