Come faccio a creare un collegamento arbitrario nella documentazione YARD?

Question

Sto cercando di creare alcuni collegamenti nella mia documentazione YARD. Posso ottenere un collegamento HTTP:

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

rende come

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

Ma un collegamento e-mail:

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

mi dà un avvertimento:

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

e rende come

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

Ho provato la sintassi RDoc regolare per i collegamenti:

bugs[mailto:bugs@myproject.com]

ma YARD sembra ignorare questo. Qualcuno sa di una sintassi più affidabile?

Answer 1

Scavando nel codice del cantiere mostra il problema: in gems/yard-0.2.3.5/lib/yard c'è la linea (73):

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

che non permette i collegamenti mailto. È possibile sostituire questa linea con

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

e funzionerà come vuoi ... non esattamente l'ideale, ma questo è tutto quello che ho in questo momento.

Answer 2

0.2.3.6 avrà questo supporto