Ruby 1.9.3 Documentation Challenge
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.
If you need help figuring out what to document you can look at the ruby documentation coverage report which updates hourly. You can run the full report yourself using make rdoc-coverage or run a partial report by installing the latest rdoc and running, for example, rdoc --encoding=UTF-8 -C lib/webrick* for coverage of all of WEBrick.
If you don't know how to contribute documentation to ruby Steve Klabnik has an excellent tutorial on contributing documentation to ruby. Note that if you send a pull request to github I can't quickly commit your change as I don't have the proper access. comments
Comments are disabled