[Rubygems-developers] When Junk Gets into the Description

Chad Fowler chad at chadfowler.com
Thu Jan 11 11:00:27 EST 2007


On 1/11/07, Anthony Eden <anthonyeden at gmail.com> wrote:
> Perhaps there needs to be a better way of handling what goes into the
> description field of a gem spec. Right now developers pretty much
> throw whatever they want in there. Sometimes it is empty, sometimes it
> is part of a README, including rdoc formatting, sometimes it is HTML,
> etc. etc. Would it be possible to be explicit in the documentation and
> either say *no markup* or specify a particular markup type?
>
> I've been trying to make the display of the description in gemtacular
> nicer, but it just isn't happening because there is no consistency. In
> the end it would probably be best to just indicate that no markup
> should be included.
>
> Just thinking out loud here... :-)
>

I think we can make a recommendation, but it will be hard to enforce.
I think no markup is the right thing to suggest.

Chad


More information about the Rubygems-developers mailing list