概要
- 症状
- Markdownにで使用したListが,yardで出力した際に正常に表示されない.githubや,Atomのプレビューでは正しく表示される.
- 原因
- Listの上下には空行が必要.
詳細
Markdownを使って以下のように箇条書きを書いていた.
[v0.1.5]
* デバッグ
* StandardErrorで例外を捕縛できない問題を修正
* DatParseException, NotA2chUrlException発生時に与えられたURLを表示するよう変更
しかし,yardでの出力はこのようなものだった.
[v0.1.5] * デバッグ * StandardErrorで例外を捕縛できない問題を修正 * DatParseException, NotA2chUrlException発生時に与えられたURLを表示するよう変更
このように表示された原因は「リストの上下に空行が必要」だった.上下に空行を入れ,
[v0.1.5]
* デバッグ
* StandardErrorで例外を捕縛できない問題を修正
* DatParseException, NotA2chUrlException発生時に与えられたURLを表示するよう変更
と記述することで,
[v0.1.5]
- デバッグ
- StandardErrorで例外を捕縛できない問題を修正
- DatParseException, NotA2chUrlException発生時に与えられたURLを表示するよう変更
と表示された.
補足
Kobitoでは,空行を入れないとプレビューが崩れるため,すぐに気づく.
Kobitoでの表示:
[v0.1.5]
* デバッグ
* StandardErrorで例外を捕縛できない問題を修正
* DatParseException, NotA2chUrlException発生時に与えられたURLを表示するよう変更