RDoc escapes <sup> tags
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
The documenetation for the Regexp class in the standard library uses <sup> which is escaped as you can see here:
https://ruby-doc.org/core-3.0.1/Regexp.html#class-Regexp-label-Capturing
Parentheses can be used for capturing. The text enclosed by the n<sup>th</sup> group of parentheses can be subsequently referred to with n. Within a pattern use the backreference
\n; outside of the pattern useMatchData[n].
Can we allow <sup> tags? I believe that, in addition to HTML, some Markdown flavors support <sup> and <sub>. For example, GitHub lets me do this: regular superscript subscript
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 escaping in the linked Regexp documentation and trace how RDoc handles the documented tags. Check the related Markdown or HTML rendering path; done means supported superscript and subscript tags render as markup instead of appearing escaped in 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
- 48/100