Comment créer un lien arbitraire dans la documentation YARD?

Question

J'essaie de créer des liens dans ma documentation YARD. Je peux obtenir un lien HTTP:

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

rend comme

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

Mais un lien e-mail:

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

me donne un avertissement:

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

et rend comme

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

J'ai essayé la syntaxe RDoc régulière pour les liens:

bugs[mailto:bugs@myproject.com] 

mais YARD semble ignorer. Est-ce que quelqu'un sait d'une syntaxe plus fiable?

Answer 1

Creuser dans le code de YARD montre le problème: dans gems/yard-0.2.3.5/lib/yard il y a la ligne (73):

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

qui ne permet pas de liens mailto. Vous pouvez remplacer cette ligne avec

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

et cela fonctionnera comme vous voulez ... pas exactement idéal, mais c'est tout ce que j'ai en ce moment.

Answer 2

0.2.3.6 aura ce soutien