2009-08-18 9 views
4

Ich versuche, einige Links in meiner YARD-Dokumentation zu erstellen. Ich kann einen HTTP-Link erhalten:Wie erstelle ich einen beliebigen Link in der YARD-Dokumentation?

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

macht als

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

Aber eine E-Mail-Link:

# You can email the {mailto:[email protected] bugs} list 

gibt mir eine Warnung:

[warn]: In file `':: Cannot resolve link to mailto:[email protected]:[email protected] 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:[email protected]] 

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

Antwort

3

YARD Code Graben in zeigt das Problem: in gems/yard-0.2.3.5/lib/yard dort die Leitung (73):

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

die nicht Mailto-Links erlaubt. Sie können mit

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

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

+2

Das ist genau das, was ich auf dieser Gabel tat http://github.com/gcnovus/yard/commit/5a977b03b8f713588703255806853ca492090a56 –

3

0.2.3.6 wird diese Unterstützung haben

Verwandte Themen