From: Simon Strandgaard <neoneye@...>
Date: 2004-03-22T08:24:30+09:00
Subject: Re: What to gem?

On Sun, 21 Mar 2004 23:11:14 +0000, gabriele renzi wrote:

> il Mon, 22 Mar 2004 06:31:53 +0900, Gavin Sinclair
> <gsinclair@soyabean.com.au> ha scritto::
> 
> 
>>Here's a tip.  Every gem you install, include the flag "--gen-rdoc".
>>That generates the RDoc for that gem.  Yes, it's in a "hidden"
>>directory, but here's the trick: run "gem_server" and point your
>>browser to http://localhost:8808, and you can access all your
>>installed documentation from one convenient place.
> 
> can I say that this is, imo, wrong?
> --gen-rdoc should be the default, and if doc generation fails a big
> banner should appear, like "Blame the author of this pkg, cause he did
> not document it". Same for tests.
>  We need to enforce best practices, as a community :)

It would be nice if there were a RubyReview team, which tried out newly
arrived packages. They write a short review about what it is, and they
rate the quality of the package [between 1..10].

is it well tested: 7
fullfill its goal: 9
documentation: 3

It will take lots of effort. Its probably better to enforce that
documentation + test must be supplied.

--
Simon Strandgaard
I wish I could spawn some more instances of me