Support multi-word backticks like `some code` in RDoc
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
From https://github.com/ruby/timeout/pull/92#discussion_r2699858272
With RDoc supporting more of Markdown, many will expect that
Here is `some code`
works.
But unfortunately it doesn't for e.g. rescue Exception:
(from https://docs.ruby-lang.org/en/master/Timeout.html#method-c-timeout)
Somewhat related: https://github.com/ruby/rdoc/issues/1230
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
Start by reproducing the rendering problem in RDoc with the example rescue Exception, then inspect how RDoc handles Markdown backticks. Compare the generated output with the linked Timeout documentation and confirm that multi-word inline code renders correctly without breaking existing inline-code cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100