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

Question

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

# I like {http://stackoverflow.com Stackoverflow}

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

<p>I like <a href="http://stackoverflow.com">Stackoverflow</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]

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

Answer 1

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

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

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

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

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

Answer 2

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