Support multi-word backticks like `some code` in RDoc

Open
#1,565 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

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

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.

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:
Image
(from https://docs.ruby-lang.org/en/master/Timeout.html#method-c-timeout)

Somewhat related: https://github.com/ruby/rdoc/issues/1230

Dominant language
Ruby
Stars
930
Forks
472
Avg merge
2d 8h
Merged PRs (30d)
12

Getting set up

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.

More from ruby/rdoc

All issues in ruby/rdoc

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.