Как создать произвольную ссылку в документации YARD?

Я пытаюсь создать несколько ссылок в моей документации YARD. Я могу получить ссылку HTTP:

# I like {http://stackru.com Stackru}

отображается как

<p>I like <a href="http://stackru.com">Stackru</a></p>

Но ссылка на электронную почту:

# You can email the {mailto:bugs@myproject.com bugs} list

дает мне предупреждение:

[warn]: In file `':: Cannot resolve link to mailto:bugs@myprojectmailto:bugs@myproject.com from text:

и отображает как

<p>You can email the <tt>bugs</tt> list</p>

Я попробовал обычный синтаксис RDoc для ссылок:

bugs[mailto:bugs@myproject.com]

но Двор, кажется, игнорирует это. Кто-нибудь знает более надежный синтаксис?

2 ответа

Решение

Копание в коде YARD показывает проблему: вgems/yard-0.2.3.5/lib/yard есть строка (73):

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

который не позволяет mailto ссылки. Вы можете заменить эту строку на

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

и это будет работать, как вы хотите... не совсем идеально, но это все, что у меня есть сейчас.

0.2.3.6 будет иметь эту поддержку

Другие вопросы по тегам