Ugly rdoc parsing on gem page

Lawrence Woodman

12 Apr, 2011 11:59 AM

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?

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.

That makes more sense now, as it did seem to be trying to do
something with RDoc.

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
README file into the description, though admittedly they
were not using RDoc.