lsegal/yard — Issue #481: Markdown-formatted doc comments not rendered correctly
Author: myronmarston
Created: 2012-02-01 06:38:30+00:00
State: open

I've got some doc comments like so:

``` ruby
# The supported record modes.
# * :all -- Record every HTTP interactions; do not play any back.
# * :none -- Do not record any HTTP interactions; play them back.
# * :new_episodes -- Playback previously recorded HTTP interactions and record new ones.
# * :once -- Record the HTTP interactions if the cassette has not already been recorded;
# otherwise, playback the HTTP interactions.
VALID_RECORD_MODES = [:all, :none, :new_episodes, :once]
```
Here's now it's looking on [rubydoc.org](http://rubydoc.info/github/myronmarston/vcr/VCR/Cassette) right now:

![](https://img.skitch.com/20120201-33tj7nsqku7r3391egq67qgfn.jpg)

In contrast, here's how it rendered before I set my yard opts to use markdown formatting (in order to make my):

![](https://img.skitch.com/20120201-gmftsdd1agjb3y4q4qe9q1y9aa.jpg)

How can I get this to render better? I think it's valid markdown, and I've tried lots of little variations but I can't get it to render well.