Invalid link parsing - broken link if ends in '.md'
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]
rdoc 6.3.1
Create the following ruby file in some folder:
# https://github.com/ruby/ruby/blob/master/README.md
class Klass
end
Run rdoc in that folder.
Run grep ruby/ruby doc/Klass.html.
Expected: link href is https://github.com/ruby/ruby/blob/master/README.md
Actual: link href is https://github_com/ruby/ruby/blob/master/README_md.html
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue with the Ruby 3.0.2 and RDoc 6.3.1 details, then inspect the generated doc/Klass.html after running rdoc and grep. Trace the link parsing that transforms the README.md URL; done means the generated href preserves the original URL, including its .md suffix.
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
- 48/100