Como faço para criar uma ligação arbitrária na documentação YARD?

Question

Eu estou tentando criar alguns links na minha documentação quintal. Posso obter um link http:

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

processa como

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

Mas um link de email:

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

me dá um aviso:

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

e processa como

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

Eu tentei a sintaxe RDoc regular para links:

bugs[mailto:bugs@myproject.com]

mas YARD parece ignorar isso. Alguém sabe de uma sintaxe mais confiável?

Answer 1

Cavando mostra o código do estaleiro o problema: em gems/yard-0.2.3.5/lib/yard existe a linha (73):

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

que não permite links mailto. Você pode substituir esta linha com

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

e irá funcionar como você quer ... não exatamente ideal, mas isso é tudo o que tenho agora.

Answer 2

0.2.3.6 terá este apoio