¿Cómo se crea un vínculo arbitrario en la documentación patio?

Question

Estoy tratando de crear algunos enlaces en mi patio documentación. Puedo conseguir un enlace HTTP:

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

renders como

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

Sin embargo, un enlace de correo electrónico:

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

me da una advertencia:

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

y hace como

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

He intentado la sintaxis RDoc regular para enlaces:

bugs[mailto:bugs@myproject.com]

YARD pero parece ignorar eso. ¿Alguien sabe de una sintaxis más fiable?

Answer 1

Excavando en el código del patio muestra el problema: en gems/yard-0.2.3.5/lib/yard existe la línea (73):

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

que no permite que los enlaces de correo. Puede reemplazar esta línea con

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

y funcionará como quiera ... no es exactamente ideal, pero eso es todo lo que tengo en este momento.

Answer 2

0.2.3.6 tendrá este apoyo