How do I create an arbitrary link in YARD documentation?

Question

I'm trying to create some links in my YARD documentation. I can get an HTTP link: ``` # I like {http://stackoverflow.com Stackoverflow} ``` renders as ```

I like Stackoverflow

``` But an email link: ``` # You can email the {mailto:bugs@myproject.com bugs} list ``` gives me a warning: ``` [warn]: In file `':: Cannot resolve link to mailto:bugs@myprojectmailto:bugs@myproject.com from text: ``` and renders as ```

You can email the bugs list

``` I've tried the regular RDoc syntax for links: ``` bugs[mailto:bugs@myproject.com] ``` but YARD seems to ignore that. Does anyone know of a more reliable syntax?

Accepted Answer

Digging into YARD's code shows the problem: in `gems/yard-0.2.3.5/lib/yard` there is the line (73):

```
if name.include?("://")
```

which doesn't allow mailto links. You can replace this line with

```
if name.include?("://") or name.include?("mailto:")
```

and it will work as you want... not exactly ideal, but that's all I've got right now.

How do I create an arbitrary link in YARD documentation?

Solution

Problem