tag:help.rubygems.org,2010-01-19:/discussions/problems/554-ugly-rdoc-parsing-on-gem-pageRubyGems.org: Discussion 2011-05-23T21:35:58Ztag:help.rubygems.org,2010-01-19:Comment/65873742011-04-12T11:59:02Z2011-04-12T11:59:03ZUgly rdoc parsing on gem page<div><p>I have uploaded a gem and found that the README.rdoc file has
been automatically presented on the RubyGems page for that gem.
However, the formatting is all off, has anyone any ideas as to how
to get around this?</p>
<p>The gem is: <a href=
"https://rubygems.org/gems/mida">Mida</a></p></div>Lawrence Woodmantag:help.rubygems.org,2010-01-19:Comment/65873742011-04-12T12:07:53Z2011-04-12T12:07:53ZUgly rdoc parsing on gem page<div><p>You should not be using RDoc as the gem specification
description or<br>
summary fields.</p>
<p>These are not intended to be formatted in the website, Plain
text is<br>
the way to go.</p></div>Luis Lavenatag:help.rubygems.org,2010-01-19:Comment/65873742011-04-12T12:12:18Z2011-04-12T12:12:19ZUgly rdoc parsing on gem page<div><p>Thanks Luis, I'll make the needed changes. It is strange though
that RubyGems tries to parse the file, as it has marked up some of
the text.</p></div>Lawrence Woodmantag:help.rubygems.org,2010-01-19:Comment/65873742011-04-21T13:59:40Z2011-04-21T13:59:40ZUgly rdoc parsing on gem page<div><p>We've known about this for a while:</p>
<p><a href=
"https://github.com/rubygems/gemcutter/issues/212#issuecomment-1039311">
https://github.com/rubygems/gemcutter/issues/212#issuecomment-1039311</a></p>
<p>Such a small portion of gems use RDoc that it hasn't been a big
issue, but I would love to get it fixed. I think in most cases
making a separate docs site is preferable to putting a ton of info
in your gem's description.</p></div>Nick Quarantotag:help.rubygems.org,2010-01-19:Comment/65873742011-04-21T14:00:28Z2011-04-21T14:00:28ZUgly rdoc parsing on gem page<div><p>Also, rubydoc.info will show your README, as will GitHub. Don't
put your whole README into the gemspec. :/</p></div>Nick Quarantotag:help.rubygems.org,2010-01-19:Comment/65873742011-04-22T05:42:40Z2011-04-22T05:42:41ZUgly rdoc parsing on gem page<div><p>Nick,</p>
<p>That makes more sense now, as it did seem to be trying to do
something with RDoc.</p>
<p>I take your point about shorter descriptions being more useful.
I'm new to Ruby and was trying to emulate the other projects that
I'd been looking at to fit in to the Ruby way. It was a little
unfortunate that the ones that caught my eye, read their full
<tt>README</tt> file into the description, though admittedly they
were not using RDoc.</p></div>Lawrence Woodmantag:help.rubygems.org,2010-01-19:Comment/65873742011-05-23T21:35:58Z2011-05-23T21:35:58ZUgly rdoc parsing on gem page<div><p>Hello Lawrence.</p>
<p>Seems all is sorted out on this issue, so I'm going to close it
out.</p>
<p>If you want you can help Nick on the GitHub issue ;-)</p>
<p>Cheers.</p></div>Luis Lavena