I think there could definitely be more documentation oriented towards internal development (routing is a good example of a poorly documented functionality).
However, I think its premature to call for a mass refactoring of the code base, at this stage in development that would be akin to sending your new baby to a plastic surgeon to have a nose job and breast implants. Bob Silva http://www.railtie.net/ ________________________________________ From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED] On Behalf Of Jonathan Viney Sent: Wednesday, April 26, 2006 7:32 AM To: rails-core@lists.rubyonrails.org Subject: Re: [Rails-core] ganging up on tests and docs Which parts of rails do you think need more documentation/tests? Are you talking about documentation for the internals of rails as well as the exposed APIs? >From the bits and pieces I've done with ActiveRecord I've been pretty impressed with the test coverage. The docs on the inner workings are a bit non-existant, but the API docs are pretty good. -Jonathan. On 4/27/06, Josh Susser <[EMAIL PROTECTED]> wrote: Hey folks, I think Ryan has a good point here: http://blog.zenspider.com/archives/2006/04/where_is_our_ma.html I'll follow that up by saying that besides tests, there's also a lot of documentation work that needs done too. Is there something we can do to improve the situation? What about having some kind of effort focused around writing JUST tests and docs that reaches out to the larger community? There are a bit over 50 days left before RailsConf - maybe we could have a contest or something during the leadup and then have some kind of award presented at the conference to whoever writes the most test/ docs. I'm not trying to make contributing into some kind of competitive thing, just brainstorming... If we could get a bunch of people to increase the test coverage, that would leave us in a better position to take on doing a stabilization/ performance/clean-up release. -- Josh Susser http://blog.hasmanythrough.com _______________________________________________ Rails-core mailing list Rails-core@lists.rubyonrails.org http://lists.rubyonrails.org/mailman/listinfo/rails-core _______________________________________________ Rails-core mailing list Rails-core@lists.rubyonrails.org http://lists.rubyonrails.org/mailman/listinfo/rails-core
