ruby / ruby/rdoc

Missing files in .../share/doc/ruby/html/

Open
#1,224 1 comment 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

We have these RI files in .../share/ri/3.3.0/system/:

DidYouMean/PlainFormatter/cdesc-PlainFormatter.ri
DidYouMean/PlainFormatter/message_for-c.ri
DidYouMean/PlainFormatter/message_for-i.ri
DidYouMean/VerboseFormatter/cdesc-VerboseFormatter.ri
DidYouMean/VerboseFormatter/message_for-c.ri
DidYouMean/VerboseFormatter/message_for-i.ri
Net/HTTPMovedTemporarily/cdesc-HTTPMovedTemporarily.ri
Net/HTTPMultipleChoice/cdesc-HTTPMultipleChoice.ri
Net/HTTPRequestEntityTooLarge/cdesc-HTTPRequestEntityTooLarge.ri
Net/HTTPRequestURITooLarge/cdesc-HTTPRequestURITooLarge.ri
Net/HTTPRequestedRangeNotSatisfiable/cdesc-HTTPRequestedRangeNotSatisfiable.ri
Object/RubyLex/cdesc-RubyLex.ri
URI/Parser/cdesc-Parser.ri
URI/Parser/convert_to_uri-i.ri
URI/Parser/escape-i.ri
URI/Parser/extract-i.ri
URI/Parser/initialize_pattern-i.ri
URI/Parser/initialize_regexp-i.ri
URI/Parser/inspect-i.ri
URI/Parser/join-i.ri
URI/Parser/make_regexp-i.ri
URI/Parser/new-c.ri
URI/Parser/parse-i.ri
URI/Parser/pattern-i.ri
URI/Parser/regexp-i.ri
URI/Parser/split-i.ri
URI/Parser/unescape-i.ri
URI/REGEXP/cdesc-REGEXP.ri
WIN32OLE/Variant/%5b%5d%3d-i.ri
WIN32OLE/Variant/%5b%5d-i.ri
WIN32OLE/Variant/array-c.ri
WIN32OLE/Variant/cdesc-Variant.ri
WIN32OLE/Variant/new-c.ri
WIN32OLE/Variant/value%3d-i.ri
WIN32OLE/Variant/value-i.ri
WIN32OLE/Variant/vartype-i.ri

But their corresponding HTML files in .../share/doc/ruby/html/ are missing:

DidYouMean/PlainFormatter.html
DidYouMean/VerboseFormatter.html
Net/HTTPMovedTemporarily.html
Net/HTTPMultipleChoice.html
Net/HTTPRequestEntityTooLarge.html
Net/HTTPRequestURITooLarge.html
Net/HTTPRequestedRangeNotSatisfiable.html
Object/RubyLex.html
URI/Parser.html
URI/REGEXP.html
WIN32OLE/Variant.html

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

Compare the RI files under .../share/ri/3.3.0/system/ with the corresponding output expected under .../share/doc/ruby/html/. Start with the listed DidYouMean, Net, Object, URI, and WIN32OLE paths and trace how their HTML files are generated. Done means the eleven listed HTML files are produced for the matching RI entries.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.