ruby / ruby/rdoc

RDoc links cannot parse obfusticated email addresses

Open
#356 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature Request
Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

README.rdoc
* {Email}[mailto:postmodern.mod3 at gmail.com]
HTML output
<p>{Email}[<a href="mailto:postmodern.mod3">postmodern.mod3</a> at gmail.com]</p>

RDoc version: 4.2.0

Contributor guide

Open the contributing guide

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.

Research direction

Start by reproducing the README.rdoc example with RDoc 4.2.0 and compare its HTML output with the expected mailto link. Trace the RDoc link parsing involved in the example; done means the obfuscated address remains intact in the generated mailto URL and the Email link renders correctly.

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
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.