ruby / ruby/rdoc

Remove RubyGems circural depednecy

Open
#690 0 comments 0 reactions 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

I believe that lib/rdoc/rubygems_hook.rb should be removed from RDoc in favor of its counterpart in RubyGems. RDoc does not need RubyGems for anything. OTOH, RubyGems requires RDoc for generating documentation. Therefore, the code belongs to RubyGems IMO, because otherwise there is a dependency loop. Actually, it used to live in RubyGems up until #2235.

TLDR; Please remove lib/rdoc/rubygems_hook.rb in favor of reverting https://github.com/rubygems/rubygems/pull/2235

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 lib/rdoc/rubygems_hook.rb and the referenced RubyGems pull request 2235 to compare where this code belongs. Done means the RDoc copy is removed and the dependency loop described in the issue is eliminated without leaving RDoc dependent on RubyGems.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.