如何创建YARD文档中的任意路段?
-
18-09-2019 - |
题
我要创建我的院子里文档中的一些链接。我可以得到一个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似乎忽略。有谁知道一个更可靠的语法?
解决方案
挖掘到Yard的代码示出了问题:在
gems/yard-0.2.3.5/lib/yard
存在线(73):
if name.include?("://")
不允许mailto链接。可以用替换这行
if name.include?("://") or name.include?("mailto:")
和它的工作,只要你想......还不够完美,但这是我的一切现在。
其他提示
0.2.3.6将有这种支持
不隶属于 StackOverflow