This post originated from an RSS feed registered with Ruby Buzz by Eric Hodel. Original Post: Ruby 1.9.3 Documentation Challenge Feed Title: Segment7 Feed URL: http://blog.segment7.net/articles.rss Feed Description: Posts about and around Ruby, MetaRuby, ruby2c, ZenTest and work at The Robot Co-op. Latest Ruby Buzz Posts Latest Ruby Buzz Posts by Eric Hodel Latest Posts From Segment7

Yugui announced a draft Ruby 1.9.3 release plan today with a feature freeze of end of May and a release target of end of July or early August.

I've seen many complaints in the form of "X lacks documentation" and have responded by writing it. First was an improvement of Net::HTTP along with Mathew Murphy and Yui NARUSE, next up was OpenSSL which received its first-ever toplevel documentation and today I committed toplevel documentation to WEBrick.

Both OpenSSL and WEBrick have some further documentation to flesh out the basic examples to help get you going but they need more work.

With revision 31499 of trunk RDoc reports that just under half of ruby has not even a single character of comments with over half of the classes and modules missing documentation:

Files:        511

Classes:     1036 ( 624 undocumented)
Modules:      228 ( 136 undocumented)
Constants:   1335 (1134 undocumented)
Attributes:   738 ( 381 undocumented)
Methods:     8098 (2960 undocumented)

Total:      11435 (5235 undocumented)
 54.22% documented

What can we do in the last month or so before the feature freeze to make this release the most-documented ever? To hit 60% documentation we only need to document another 1626 items.

To do my part, if you assign documentation patches to me on the Ruby 1.9 tracker on redmine I will commit them. I'll also keep writing documentation to fill in the gaps.