ruby - 如何在 YARD 文档中创建任意链接？

Question

我正在尝试在我的 YARD 文档中创建一些链接。我可以获得一个 HTTP 链接:

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

呈现为

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

但是一个电子邮件链接:

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

给我一​​个警告:

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

并呈现为

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

我试过链接的常规 RDoc 语法:

bugs[mailto:bugs@myproject.com]

但 YARD 似乎忽略了这一点。有谁知道更可靠的语法？

Answer 1

深入研究 YARD 的代码显示了问题:在gems/yard-0.2.3.5/lib/yard 有行 (73):

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

不允许 mailto 链接。您可以将此行替换为

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

它会按照您的意愿工作...不是很理想，但这就是我现在所拥有的。