どのように私はYARDのドキュメント内の任意のリンクを作成するのですか?

StackOverflow https://stackoverflow.com/questions/1294024

  •  18-09-2019
  •  | 
  •  

質問

私は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はそれを無視しているようです。誰もがより信頼性の高い構文を知っていますか?

役に立ちましたか?

解決

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は、このサポートを持つことになります。

ライセンス: CC-BY-SA帰属
所属していません StackOverflow
scroll top