RDoc & markdown: backquoted methods should be linked like unquoted ones.
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
I think the following doc should ideally generate the same HTML:
### Example doc
Call Hash#transform_values to achieve something cool
Call `Hash#transform_values` to achieve something cool
Currently the backquoted version will not link to the Hash#transform_values method.
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 issue with the two Markdown examples in the report and compare the generated HTML. Trace how RDoc handles unquoted versus backquoted method references; done means both forms link to Hash#transform_values in the generated documentation.
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
- 45/100