Doc Project: Progress update

mrneighborly : March 12th, 2007

It’s fun coming up with the number of ways I can say “Documentation Project update.”

We got a lot done today. We finally meshed on a method template that we’ll use for documenting all methods, and started documenting a lot of methods with it! I tackled the ActionController::Assertions module(s) while Jamie kept hammering away on ActiveRecord. He got the README done (and part of the AR::Base docs) while I got two patches done for the Assertions (and one started for ActionView::Base after restarting to match our decided upon layout for README/::Base docs). Here are the tickets:

  • 7747 : Better structured Active Record readme Updated to fix an rdoc formatting error
  • 7802 : ActionController::DomAssertions module, explaining what it’s for, better explaining the methods, and providing examples.
  • 7803 : ActionController::Assertions module, second patch in an effort to improve these docs.
  • 7808 : ActiveRecord::Base, overview is a little rounder but plenty left to go on this one

See you next week. :)

Sorry, comments are closed for this article.