2 ms·
Rails is not a library. It wouldn't serve anybody to write a dissertation in every file about how that file fits into the whole framework. Rails API documenta
by dasil003 16y ago
Rails is not a library. It wouldn't serve anybody to write a dissertation in every file about how that file fits into the whole framework.
Rails API documentation is far from perfect, but a surprising amount of the important stuff is covered in a few consolidated locations. The documentation for some modules is often consolidated in a more central location so you can get a better overview of the whole API. See ActionController::Base, ActiveRecord::Base, ActiveRecord::Associations::ClassMethods for example. As for I18n, well, I18n is an external gem, it is not core to Rails which is why it is not documented there.
No one is arguing that Rails API documentation is newbie friendly, but I would argue that the purpose of API documentation is not to introduce people to the framework; it's reference material. The Rails Guides are pretty good (if not lagging a bit for some aspects of Rails 3) and I would put them up against any other framework documentation I've used.