Wie kann ich einen beliebigen Link in YARD Dokumentation erstellen?

Question

Ich versuche, ein paar Links in meiner YARD Dokumentation zu erstellen. Ich kann einen HTTP-Link bekommen:

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

rendert als

<p>I like <a href="http://stackoverflow.com">Stackoverflow</a></p>

Aber ein E-Mail-Link:

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

gibt mir eine Warnung:

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

und macht als

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

Ich habe die regelmäßige RDoc Syntax für Links versucht:

bugs[mailto:bugs@myproject.com]

aber YARD scheint das zu ignorieren. Kennt jemand eine zuverlässigere Syntax?

Answer 1

in dem Code des YARD Graben zeigt das Problem: in gems/yard-0.2.3.5/lib/yard gibt es die Linie (73):

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

, die nicht erlaubt Mailto-Links. Sie können diese Zeile ersetzen mit

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

und es wird funktionieren, wie Sie wollen ... nicht gerade ideal, aber das ist alles, was ich jetzt habe.

Answer 2

0.2.3.6 wird diese Unterstützung