Autolink text in fixed-width font
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
RDoc autolinks text without markup and removes a leading hash if there is one.
That's a great feature, but if you have for example method or class names that cannot be autolinked, either you use a hash and regular text (which would still leave true or User to be confusing mixed with regular text), or switch to fixed-width font (inconsistent with the autolinked ones).
Fixed-width font is a very common convention for method names, constants, nil, etc. in rich-formatted docs like books. Visually the reader sees that save is a method or variable name, rather than the English word "save", you know.
Would it be possible that RDoc autolinks and respects the font in +...+ or <tt>...</tt>?
/cc @senny
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 locating RDoc's autolinking and fixed-width markup handling, then inspect existing tests for autolink behavior. Done means text inside +...+ or ... can still be autolinked while retaining fixed-width formatting, with coverage for the requested cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100