Ugly rdoc parsing on gem page

Lawrence Woodman's Avatar

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?

The gem is: Mida

  1. Support Staff 2 Posted by Luis Lavena on 12 Apr, 2011 12:07 PM

    Luis Lavena's Avatar

    You should not be using RDoc as the gem specification description or
    summary fields.

    These are not intended to be formatted in the website, Plain text is
    the way to go.

  2. 3 Posted by Lawrence Woodman on 12 Apr, 2011 12:12 PM

    Lawrence Woodman's Avatar

    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.

  3. Support Staff 4 Posted by Nick Quaranto on 21 Apr, 2011 01:59 PM

    Nick Quaranto's Avatar

    We've known about this for a while:

    https://github.com/rubygems/gemcutter/issues/212#issuecomment-1039311

    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.

  4. Support Staff 5 Posted by Nick Quaranto on 21 Apr, 2011 02:00 PM

    Nick Quaranto's Avatar

    Also, rubydoc.info will show your README, as will GitHub. Don't put your whole README into the gemspec. :/

  5. 6 Posted by Lawrence Woodman on 22 Apr, 2011 05:42 AM

    Lawrence Woodman's Avatar

    Nick,

    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.

  6. Support Staff 7 Posted by Luis Lavena on 23 May, 2011 09:35 PM

    Luis Lavena's Avatar

    Hello Lawrence.

    Seems all is sorted out on this issue, so I'm going to close it out.

    If you want you can help Nick on the GitHub issue ;-)

    Cheers.

  7. Luis Lavena closed this discussion on 23 May, 2011 09:35 PM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts

Generic

? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac

Recent Discussions

29 Aug, 2014 06:23 PM
28 Aug, 2014 07:18 PM
27 Aug, 2014 12:03 PM
26 Aug, 2014 07:09 PM
26 Aug, 2014 07:07 PM